netdata/netdata

View on GitHub
src/go/collectors/go.d.plugin/modules/example/config_schema.json

Summary

Maintainability
Test Coverage
{
  "jsonSchema": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Example collector configuration.",
    "type": "object",
    "properties": {
      "update_every": {
        "title": "Update every",
        "description": "Data collection interval, measured in seconds.",
        "type": "integer",
        "minimum": 1,
        "default": 1
      },
      "charts": {
        "title": "Charts configuration",
        "type": [
          "object",
          "null"
        ],
        "properties": {
          "type": {
            "title": "Chart type",
            "description": "The type of all charts.",
            "type": "string",
            "enum": [
              "line",
              "area",
              "stacked"
            ],
            "default": "line"
          },
          "num": {
            "title": "Number of charts",
            "description": "The total number of charts to create.",
            "type": "integer",
            "minimum": 0,
            "default": 1
          },
          "contexts": {
            "title": "Number of contexts",
            "description": "The total number of unique contexts.",
            "type": "integer",
            "minimum": 0,
            "default": 0
          },
          "dimensions": {
            "title": "Number of dimensions",
            "description": "The number of dimensions each chart will have.",
            "type": "integer",
            "minimum": 1,
            "default": 4
          },
          "labels": {
            "title": "Number of labels",
            "description": "The number of labels each chart will have.",
            "type": "integer",
            "minimum": 0,
            "default": 0
          }
        },
        "required": [
          "type",
          "num",
          "contexts",
          "dimensions",
          "labels"
        ]
      },
      "hidden_charts": {
        "title": "Hidden charts configuration",
        "type": [
          "object",
          "null"
        ],
        "properties": {
          "type": {
            "title": "Chart type",
            "description": "The type of all charts.",
            "type": "string",
            "enum": [
              "line",
              "area",
              "stacked"
            ],
            "default": "line"
          },
          "num": {
            "title": "Number of charts",
            "description": "The total number of charts to create.",
            "type": "integer",
            "minimum": 0,
            "default": 0
          },
          "contexts": {
            "title": "Number of contexts",
            "description": "The total number of unique contexts.",
            "type": "integer",
            "minimum": 0,
            "default": 0
          },
          "dimensions": {
            "title": "Number of dimensions",
            "description": "The number of dimensions each chart will have.",
            "type": "integer",
            "minimum": 1,
            "default": 4
          },
          "labels": {
            "title": "Number of labels",
            "description": "The number of labels each chart will have.",
            "type": "integer",
            "minimum": 0,
            "default": 0
          }
        },
        "required": [
          "type",
          "num",
          "contexts",
          "dimensions",
          "labels"
        ]
      }
    },
    "required": [
      "charts"
    ],
    "additionalProperties": false,
    "patternProperties": {
      "^name$": {}
    }
  },
  "uiSchema": {
    "uiOptions": {
      "fullPage": true
    },
    "charts": {
      "type": {
        "ui:widget": "radio",
        "ui:options": {
          "inline": true
        }
      }
    },
    "hidden_charts": {
      "type": {
        "ui:widget": "radio",
        "ui:options": {
          "inline": true
        }
      }
    },
    "ui:flavour": "tabs",
    "ui:options": {
      "tabs": [
        {
          "title": "Base",
          "fields": [
            "update_every"
          ]
        },
        {
          "title": "Charts",
          "fields": [
            "charts"
          ]
        },
        {
          "title": "Hidden charts",
          "fields": [
            "hidden_charts"
          ]
        }
      ]
    }
  }
}