Class EmfMetricLoggingPublisher.Builder

java.lang.Object

software.amazon.awssdk.metrics.publishers.emf.EmfMetricLoggingPublisher.Builder

Enclosing class:

EmfMetricLoggingPublisher

public static final class EmfMetricLoggingPublisher.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
EmfMetricLoggingPublisher	build()	Build a EmfMetricLoggingPublisher using the configuration currently configured on this publisher.
EmfMetricLoggingPublisher.Builder	dimensions(Collection<SdkMetric<String>> dimensions)	Configure the SdkMetric that are used to define the Dimension Set Array that will be put into the emf log to this publisher.
final EmfMetricLoggingPublisher.Builder	dimensions(SdkMetric<String>... dimensions)
EmfMetricLoggingPublisher.Builder	logGroupName(String logGroupName)	Configure the LogGroupName key that will be put into the emf log to this publisher.
EmfMetricLoggingPublisher.Builder	metricCategories(Collection<MetricCategory> metricCategories)	Configure the MetricCategorys that should be uploaded to CloudWatch.
EmfMetricLoggingPublisher.Builder	metricCategories(MetricCategory... metricCategories)
EmfMetricLoggingPublisher.Builder	metricLevel(MetricLevel metricLevel)	Configure the MetricLevel that should be uploaded to CloudWatch.
EmfMetricLoggingPublisher.Builder	namespace(String namespace)	Configure the namespace that will be put into the emf log to this publisher.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

namespace

public EmfMetricLoggingPublisher.Builder namespace(String namespace)

Configure the namespace that will be put into the emf log to this publisher.

If this is not specified, AwsSdk/JavaSdk2 will be used.

dimensions

public EmfMetricLoggingPublisher.Builder dimensions(Collection<SdkMetric<String>> dimensions)

Configure the SdkMetric that are used to define the Dimension Set Array that will be put into the emf log to this publisher.

If this is not specified, CoreMetric.SERVICE_ID and CoreMetric.OPERATION_NAME will be used.

dimensions

@SafeVarargs
public final EmfMetricLoggingPublisher.Builder dimensions(SdkMetric<String>... dimensions)

See Also:

• dimensions(SdkMetric[])

metricCategories

public EmfMetricLoggingPublisher.Builder metricCategories(Collection<MetricCategory> metricCategories)

Configure the MetricCategorys that should be uploaded to CloudWatch.

If this is not specified, MetricCategory.ALL is used.

All SdkMetrics are associated with at least one MetricCategory. This setting determines which category of metrics uploaded to CloudWatch. Any metrics EmfMetricLoggingPublisher.publish(MetricCollection)ed that do not fall under these configured categories are ignored.

Note: If there are dimensions(Collection) configured that do not fall under these MetricCategory values, the dimensions will NOT be ignored. In other words, the metric category configuration only affects which metrics are uploaded to CloudWatch, not which values can be used for dimensions.

metricCategories

public EmfMetricLoggingPublisher.Builder metricCategories(MetricCategory... metricCategories)

See Also:

• metricCategories(Collection)

logGroupName

public EmfMetricLoggingPublisher.Builder logGroupName(String logGroupName)

Configure the LogGroupName key that will be put into the emf log to this publisher. This is required when using the CloudWatch agent to send embedded metric format logs that tells the agent which log group to use.

If this is not specified, for AWS lambda environments, AWS_LAMBDA_LOG_GROUP_NAME is used. This field is required and must not be null or empty for non-lambda environments.

Throws:

NullPointerException - if non-lambda environment and logGroupName is null

metricLevel

public EmfMetricLoggingPublisher.Builder metricLevel(MetricLevel metricLevel)

Configure the MetricLevel that should be uploaded to CloudWatch.

If this is not specified, MetricLevel.INFO is used.

All SdkMetrics are associated with one MetricLevel. This setting determines which level of metrics uploaded to CloudWatch. Any metrics EmfMetricLoggingPublisher.publish(MetricCollection)ed that do not fall under these configured categories are ignored.

Note: If there are dimensions(Collection) configured that do not fall under this MetricLevel values, the dimensions will NOT be ignored. In other words, the metric category configuration only affects which metrics are uploaded to CloudWatch, not which values can be used for dimensions.

build

public EmfMetricLoggingPublisher build()

Build a EmfMetricLoggingPublisher using the configuration currently configured on this publisher.