Home > Configuration > Metrics > addmetricsprofile

addmetricsprofile

Use this method to adds a new metrics profile

Syntax



Parameters

name

Name for the metrics profile. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.!.
This is mandatory parameter.

collector

The collector should be a HTTP/HTTPS service.

outputmode

This option indicates the format in which metrics data is generated
Default value = NS_ANALYTICS_OUT_MODE_AVRO.

metrics

This option is used enable or disable metrics
Default value = DISABLED.

servemode

This option is to configure metrics pull or push mode. In push mode metricscollector exports metrics to configured collector. In pull mode, metricscollector only generates the metrics which will be pulled by external agent. No collector configuration is required in pull mode and it is applicable only for output mode Prometheus
Default value = NS_ANALYTICS_SERVE_PUSH_MODE.

schemafile

This option is for configuring json schema file containing a list of counters to be exported by metricscollector. Schema file should be present under /var/metrics_conf path
Default value = NS_S_ANALYTICS_DEFAULT_SCHEMA_FILE.

metricsexportfrequency

This option is for configuring the metrics export frequency in seconds, frequency value must be in [30,300] seconds range
Default value = 30.
Minimum value = 30.
Maximum value = 300.

metricsauthtoken

Token for authenticating with the endpoint. If the endpoint requires the Authorization header in a particular format, specify the complete format as the value to this parameter. For eg., in case of splunk, the Authorizaiton header is required to be of the form - Splunk .

metricsendpointurl

The URL at which to upload the metrics data on the endpoint

Return Value

Returns simpleResult

See Also