Skip to content

Commit 7fbd31a

Browse files
authored
Fixed typos in README (#26)
* Fixed typos in README
1 parent 3fc4c5c commit 7fbd31a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Generate CloudWatch Metrics embedded within structured log events. The embedded
1919

2020
- **Linking metrics to high cardinality context**
2121

22-
Using the Embedded Metric Format, you will be able to visualize and alarm on custom metrics, but also retain the original, detailed and high-cardinality context which is queryable using [CloudWatch Logs Insights](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html). For example, the library automatically injects environment metadata such as Lambda Function version, EC2 instance and image ids into the structured log event data.
22+
Using the Embedded Metric Format, you will be able to visualize and alarm on custom metrics, but also retain the original, detailed and high-cardinality context which is queryable using [CloudWatch Logs Insights](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html). For example, the library automatically injects environment metadata such as Lambda Function version, EC2 instance and image ids into the structured log event data.
2323
Be sure to:
2424

2525
## Usage
@@ -63,7 +63,7 @@ Requirements:
6363
Examples:
6464

6565
```java
66-
put_metric("Latency", 200, Unit.MILLISECONDS)
66+
putMetric("Latency", 200, Unit.MILLISECONDS)
6767
```
6868

6969
- MetricsLogger **putProperty**(String key, Object value )
@@ -78,7 +78,7 @@ Examples:
7878

7979
```java
8080
putProperty("RequestId", "422b1569-16f6-4a03-b8f0-fe3fd9b100f8")
81-
putPropertyproperty("InstanceId", "i-1234567890")
81+
putProperty("InstanceId", "i-1234567890")
8282
putPproperty("Device", new HashMap<String, String>() {{
8383
put("Id", "61270781-c6ac-46f1-baf7-22c808af8162");
8484
put("Name", "Transducer");
@@ -171,7 +171,7 @@ Configuration config = EnvironmentConfigurationProvider.getConfig();
171171
config.setServiceName("MyApp")
172172

173173
# environment
174-
AWS_EMF_SERVICE_NAME = MyApp
174+
AWS_EMF_SERVICE_NAME="MyApp"
175175
```
176176

177177
**ServiceType**: Overrides the type of the service. For services where the type cannot be inferred (e.g. Java process running on EC2), a default value of Unknown will be used if not explicitly set.
@@ -213,7 +213,7 @@ Configuration config = EnvironmentConfigurationProvider.getConfig();
213213
config.setLogGroupName("LogGroupName")
214214

215215
# environment
216-
AWS_EMF_LOG_GROUP_NAME=LogGroupName
216+
AWS_EMF_LOG_GROUP_NAME="LogGroupName"
217217
```
218218

219219
**LogStreamName**: For agent-based platforms, you may optionally configure the destination log stream that metrics should be delivered to. This value will be passed from the library to the agent in the Embedded Metric payload. If a LogGroup is not provided, the default value will be derived by the agent (this will likely be the hostname).
@@ -234,7 +234,7 @@ Configuration config = EnvironmentConfigurationProvider.getConfig();
234234
config.setLogStreamName(LogStreamName))
235235

236236
# environment
237-
AWS_EMF_LOG_STREAM_NAME=LogStreamName
237+
AWS_EMF_LOG_STREAM_NAME="LogStreamName"
238238
```
239239

240240
**EnvironmentOverride**: Short circuit auto-environment detection by explicitly defining how events should be sent. This is not supported through programmatic access.

0 commit comments

Comments
 (0)