getmetricsprofileResult Structure Definition

The getmetricsprofileResult structure defines the return type for getmetricsprofile API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

metricsprofileList

List of metricsprofiles


metricsprofile Structure Definition

The metricsprofile structure defines the actual return type values for getmetricsprofile API.

Syntax



Members

name

Name of the profile about which to display information.

collector

The collector should be a HTTP/HTTPS service.

refcnt

The number of references to the profile.

outputmode

This option indicates the format in which metrics data is generated

metrics

This option is used enable or disable metrics

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

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

metricsexportfrequency

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

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

entitytype

Type of the entity bound to the metrics profile.

entityname

Name of the entity bound to the metrics profile.

_nextgenapiresource


See Also