Module cloudwatch/logs

@pulumi/awsx > cloudwatch > logs

function deliveryErrors

deliveryErrors(change?: CloudWatchMetricChange): Metric

The number of log events for which CloudWatch Logs received an error when forwarding data to the subscription destination.

Valid Dimensions: LogGroupName, DestinationType, FilterName Valid Statistic: Sum Units: None

function deliveryThrottling

deliveryThrottling(change?: CloudWatchMetricChange): Metric

The number of log events for which CloudWatch Logs was throttled when forwarding data to the subscription destination.

Valid Dimensions: LogGroupName, DestinationType, FilterName Valid Statistic: Sum Units: None

function forwardedBytes

forwardedBytes(change?: CloudWatchMetricChange): Metric

The volume of log events in compressed bytes forwarded to the subscription destination.

Valid Dimensions: LogGroupName, DestinationType, FilterName Valid Statistic: Sum Units: Bytes

function forwardedLogEvents

forwardedLogEvents(change?: CloudWatchMetricChange): Metric

The number of log events forwarded to the subscription destination.

Valid Dimensions: LogGroupName, DestinationType, FilterName Valid Statistic: Sum Units: None

function incomingBytes

incomingBytes(change?: CloudWatchMetricChange): Metric

The volume of log events in uncompressed bytes uploaded to CloudWatch Logs. When used with the LogGroupName dimension, this is the volume of log events in uncompressed bytes uploaded to the log group.

Valid Dimensions: LogGroupName Valid Statistic: Sum Units: Bytes

function incomingLogEvents

incomingLogEvents(change?: CloudWatchMetricChange): Metric

The number of log events uploaded to CloudWatch Logs. When used with the LogGroupName dimension, this is the number of log events uploaded to the log group.

Valid Dimensions: LogGroupName Valid Statistic: Sum Units: None

function metric

metric(metricName: CloudWatchLogMetricName, change: CloudWatchMetricChange): Metric

CloudWatch Logs sends metrics to Amazon CloudWatch every minute.

Creates an AWS/Logs metric with the requested [metricName]. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Monitoring-CloudWatch-Metrics.html for list of all metric-names.

Note, individual metrics can easily be obtained without supplying the name using the other [metricXXX] functions.

The dimensions that you can use with CloudWatch Logs metrics are: 1. “LogGroupName”: The name of the CloudWatch Logs log group for which to display metrics. 2. “DestinationType”: The subscription destination for the CloudWatch Logs data, which can be AWS Lambda, Amazon Kinesis Data Streams, or Amazon Kinesis Data Firehose. 3. “FilterName”: The name of the subscription filter that is forwarding data from the log group to the destination. The subscription filter name is automatically converted by CloudWatch to ASCII and any unsupported characters get replaced with a question mark (?).

interface CloudWatchMetricChange

extends MetricChange

property color

color?: pulumi.Input<string>;

The six-digit HTML hex color code to be used for this metric.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

property destinationType

destinationType?: undefined | string;

The subscription destination for the CloudWatch Logs data, which can be AWS Lambda, Amazon Kinesis Data Streams, or Amazon Kinesis Data Firehose.

property dimensions

dimensions?: pulumi.Input<Record<string, any>>;

The new dimension for this metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be cleared.

property extendedStatistic

extendedStatistic?: pulumi.Input<number>;

The new percentile statistic for the metric associated with the alarm. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.

property filterName

filterName?: undefined | string;

The name of the subscription filter that is forwarding data from the log group to the destination. The subscription filter name is automatically converted by CloudWatch to ASCII and any unsupported characters get replaced with a question mark (?).

property label

label?: pulumi.Input<string>;

The label to display for this metric in the graph legend. If this is not specified, the metric is given an autogenerated label that distinguishes it from the other metrics in the widget.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

property logGroup

logGroup?: aws.cloudwatch.LogGroup;

Filters down events to those from the specified [LogGroup].

property period

period?: pulumi.Input<number>;

The new period in seconds over which the specified stat is applied. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default (300s).

property statistic

statistic?: pulumi.Input<MetricStatistic>;

The new statistic to apply to the alarm’s associated metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.

property unit

unit?: pulumi.Input<MetricUnit>;

The new unit for this metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.

property visible

visible?: pulumi.Input<boolean>;

Set this to true to have the metric appear in the graph, or false to have it be hidden. The default is true.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

property yAxis

yAxis?: pulumi.Input<“left” | “right”>;

Where on the graph to display the y-axis for this metric. The default is left.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

type CloudWatchLogMetricName

type CloudWatchLogMetricName = “IncomingBytes” | “IncomingLogEvents” | “ForwardedBytes” | “ForwardedLogEvents” | “DeliveryErrors” | “DeliveryThrottling”;