Skip to content
AlexMuliar edited this page Sep 30, 2022 · 9 revisions

Source file config

Property Type Description
type String Specify source type. Value - prtg
name String Unique source name - also the config filename
config Object Source configuration

config object properties:

Property Type Required Description
url String yes URL to fetch data from
verify_ssl Boolean no whether to verify SSL certificate when connecting via HTTPS, default: true
authentication Object no Authentication details config

authentication object properties:

Property Type Required Description
type String yes Authentication type. Available options: ['basic']
username String yes Authentication username
password String yes Authentication password

Example

[
  {
    "name": "prtg",
    "type": "prtg",
    "config": {
      "url": "http://some_host:80/file.xml",
      "authentication": {
        "type": "basic",
        "username": "admin",
        "password": "admin"
      }
    }
  }
]

Pipeline file config

Properties list

Property Required Value type Description
source yes String Source config name
pipeline_id yes String Unique pipeline identifier (use a human-readable name so you could easily use it further)
interval yes Integer Query data every N seconds
values yes object Key-value pairs. A target type represents how samples of the same metric are aggregated in Anodot. Valid values are: gauge (average aggregation), counter (sum aggregation)
units no Object Key-value pairs (value:unit). The value must be from the values column, units can be any.
dimensions yes Object Names of columns that will be used as dimensions, columns may only be strings. These fields may be missing in a record
tags no Object with key-value pairs Tags
watermark_in_local_timezone no Boolean If the watermark should be calculated based on the local timezone. This option is needed if your Anodot account timezone is not UTC, but your local timezone. Default - false
timezone no String A timezone of a timestamp field if its type is string, e.g. Europe/London, default UTC
notifications no object See notifications page

Dimensions object properties:

Property Type Description
required List of strings These properties are always present in a record
optional List of strings These properties may be missing in a record

Example

[
  {
    "source": "prtg",
    "pipeline_id": "prtg",
    "values": {
      "Measurement 1": "counter",
      "Measurement 2": "gauge"
    },
    "units": {
      "Measurement 1": "example_unit_1",
      "Measurement 2": "example_unit_2"
    },
    "dimensions": {
      "required": ["Dimension 1", "Dimension 2"],
      "optional": []
    },
    "timestamp": {
      "name": "timestamp_unix",
      "type": "unix"
    },
    "interval": 300,
    "tags": {"key1": "value1", "key2": "value2"}
  }
]
Clone this wiki locally