IntegrationMetrics
IntegrationMetrics
Definition of the metrics belonging this integration
JSON Example
{
"chartObjs": [
{
"base": 0,
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": false,
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": false,
"sourceColor": "string",
"secondaryAxis": false,
"scatterPlotSource": "string"
}
],
"noDefaultEvents": false,
"summarization": "string",
"includeObsoleteMetrics": false,
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": 0,
"fixedLegendEnabled": false,
"fixedLegendUseRawStats": false,
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": 0,
"showHosts": false,
"showLabels": false,
"showRawValues": false,
"showValueColumn": false,
"autoColumnTags": false,
"columnTags": "string",
"tagMode": "string",
"numTags": 0,
"groupBySource": false,
"sortValuesDescending": false,
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": false,
"y1ScaleSIBy1024": false,
"y0UnitAutoscaling": false,
"y1UnitAutoscaling": false,
"invertDynamicLegendHoverControl": false,
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": false,
"fixedLegendShowMetricName": false,
"fixedLegendFilterLimit": 0,
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": false,
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": false,
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
0
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": 0,
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": false,
"anomalyDetectionOn": false,
"filterOutNonAnomalies": false,
"displayConfidenceBounds": false
}
],
"display": [
"string"
],
"required": [
"string"
],
"charts": [
"string"
],
"prefixes": [
"string"
],
"ppsDimensions": [
"string"
]
}array of string
display
Required
Set of metrics that are displayed in the metric panel during integration setup
array of string
required
Required
Set of "canary" metrics that define the "liveness" of this integration's metric ingestion
array of string
charts
Required
URLs for JSON definitions of charts that display info about this integration's metrics
array of string
prefixes
Required
Set of metric prefix namespaces belonging to this integration
array of string
ppsDimensions
Optional
For reported points belonging to this integration, these point tags are escalated to the internal point-rate counters so that reporting can be broken out by these dimensions