Skip to content

/AWS1/CL_SGMMETRICSENDPOINT

Specifies a metrics endpoint for a container, including the path where the container exposes Prometheus-formatted metrics and the frequency at which to publish them to Amazon CloudWatch.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_metricsendpointpath TYPE /AWS1/SGMMETRICSENDPOINTPATH /AWS1/SGMMETRICSENDPOINTPATH

The path to the metrics endpoint exposed by the container. For example, /metrics or /server/metrics. The path must start with / and can contain alphanumeric characters, forward slashes, underscores, hyphens, and periods. Maximum length is 256 characters. If not specified, defaults to /metrics.

Optional arguments:

iv_metricpubfrequencyinsecs TYPE /AWS1/SGMMETRICPUBFREQUENCYI00 /AWS1/SGMMETRICPUBFREQUENCYI00

The interval, in seconds, at which container metrics scraped from the endpoint are published to Amazon CloudWatch. Valid values: 10, 30, 60, 120, 180, 240, 300. Defaults to 60.


Queryable Attributes

MetricsEndpointPath

The path to the metrics endpoint exposed by the container. For example, /metrics or /server/metrics. The path must start with / and can contain alphanumeric characters, forward slashes, underscores, hyphens, and periods. Maximum length is 256 characters. If not specified, defaults to /metrics.

Accessible with the following methods

Method Description
GET_METRICSENDPOINTPATH() Getter for METRICSENDPOINTPATH, with configurable default
ASK_METRICSENDPOINTPATH() Getter for METRICSENDPOINTPATH w/ exceptions if field has no
HAS_METRICSENDPOINTPATH() Determine if METRICSENDPOINTPATH has a value

MetricPublishFrequencyInSeconds

The interval, in seconds, at which container metrics scraped from the endpoint are published to Amazon CloudWatch. Valid values: 10, 30, 60, 120, 180, 240, 300. Defaults to 60.

Accessible with the following methods

Method Description
GET_METRICPUBFREQUENCYINSECS() Getter for METRICPUBFREQUENCYINSECONDS, with configurable de
ASK_METRICPUBFREQUENCYINSECS() Getter for METRICPUBFREQUENCYINSECONDS w/ exceptions if fiel
HAS_METRICPUBFREQUENCYINSECS() Determine if METRICPUBFREQUENCYINSECONDS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_METRICSENDPOINTLIST

TYPES TT_METRICSENDPOINTLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_SGMMETRICSENDPOINT WITH DEFAULT KEY
.