Skip to content

Commit ce73c0d

Browse files
authored
Improvement for README (#28)
1 parent e46bd36 commit ce73c0d

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
![](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiNFp3emNQV0dUbWg5bHBqbXZsMjlOY0dZN0xFTlc3aVhQV1dnVW1uS1kxU3FINlpmRTlIYjNQdHRkcVVvM1RNK3ZLQ25qRHZkK1pBTFIxWFUwaU1NcktjPSIsIml2UGFyYW1ldGVyU3BlYyI6InFzblFPZGgzWXF2V2V5OFYiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)
44

5-
Generate CloudWatch Metrics embedded within structured log events. The embedded metrics will be extracted so you can visualize and alarm on them for real-time incident detection. This allows you to monitor aggregated values while preserving the detailed event context that generated them.
6-
5+
Generate CloudWatch metrics embedded within structured log events. The embedded metrics will be extracted so that you can visualize and alarm on them for real-time incident detection. This allows you to monitor aggregated values while preserving the detailed log event context that generates them.
76
- [Use Cases](#use-cases)
87
- [Usage](#usage)
98
- [API](#api)
@@ -14,7 +13,7 @@ Generate CloudWatch Metrics embedded within structured log events. The embedded
1413

1514
- **Generate custom metrics across compute environments**
1615

17-
- Easily generate custom metrics from Lambda functions without requiring custom batching code, making blocking network requests or relying on 3rd party software.
16+
- Easily generate custom metrics from Lambda functions without requiring custom batching code, making blocking network requests or relying on third-party software.
1817
- Other compute environments (EC2, On-prem, ECS, EKS, and other container environments) are supported by installing the [CloudWatch Agent](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Embedded_Metric_Format_Generation_CloudWatch_Agent.html).
1918

2019
- **Linking metrics to high cardinality context**
@@ -57,7 +56,7 @@ Requirements:
5756
- Name Length 1-255 characters
5857
- Name must be ASCII characters only
5958
- Values must be in the range of 8.515920e-109 to 1.174271e+108. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
60-
- Units must meet CW Metrics unit requirements, if not it will default to None. See [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) for valid values.
59+
- Units must meet CloudWatch Metrics unit requirements, if not it will default to None. See [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) for valid values.
6160

6261
Examples:
6362

@@ -88,9 +87,9 @@ putProperty("Device", new HashMap<String, String>() {{
8887

8988
- MetricsLogger **putDimensions**(DimensionSet dimensions)
9089

91-
Adds a new set of dimensions that will be associated to all metric values.
90+
Adds a new set of dimensions that will be associated with all metric values.
9291

93-
**WARNING**: Every distinct value will result in a new CloudWatch Metric.
92+
**WARNING**: Every distinct value for a dimension set will result in a new CloudWatch metric.
9493
If the cardinality of a particular value is expected to be high, you should consider
9594
using `setProperty` instead.
9695

@@ -110,7 +109,7 @@ putDimensions(DimensionSet.of("Operation", "Aggregator", "DeviceType", "Actuator
110109

111110
Explicitly override all dimensions. This will remove the default dimensions.
112111

113-
**WARNING**: Every distinct value will result in a new CloudWatch Metric.
112+
**WARNING**: Every distinct value for a dimension set will result in a new CloudWatch metric.
114113
If the cardinality of a particular value is expected to be high, you should consider
115114
using `setProperty` instead.
116115

0 commit comments

Comments
 (0)