Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: bumped aws components to 1.0 #658

Merged
merged 12 commits into from
Oct 22, 2021
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const tracerProvider = new NodeTracerProvider({ resource });

## Available detectors

- `awsBeanstalkDetector`: Populates `service` for processes running on [AWS Elastic Beanstalk](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/Welcome.html)
- `awsBeanstalkDetector`: Populates `service` for processes running on [AWS Elastic Beanstalk](https://aws.amazon.com/elasticbeanstalk/)
- `awsEc2Detector`: Populates `cloud` and `host` for processes running on [Amazon EC2](https://aws.amazon.com/ec2/), including abstractions such as ECS on EC2. Notably, it does not populate anything on AWS Fargate
- `awsEcsDetector`: Populates `container` for containers running on [Amazon ECS](https://aws.amazon.com/ecs/)
- `awsEksDetector`: Populates `container` and `k8s.cluster_name` for containers running on [Amazon EKS](https://aws.amazon.com/eks/)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
},
"devDependencies": {
"@opentelemetry/api": "1.0.2",
"@opentelemetry/contrib-test-utils": "^0.25.0",
"@opentelemetry/contrib-test-utils": "^0.26.0",
"@types/mocha": "8.2.3",
"@types/node": "14.17.9",
"@types/sinon": "10.0.2",
Expand Down
7 changes: 3 additions & 4 deletions packages/opentelemetry-id-generator-aws-xray/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,15 @@ const tracerProvider = new NodeTracerProvider(tracerConfig);

Example trace ID format: 58406520a006649127e371903a2de979

A trace ID consists of two parts; the timestamp and the unique identifier.
A trace ID consists of two parts: the timestamp and the unique identifier.

#### Time Stamp
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know changing the docs wasn't the intention of the PR, but it caught my eye since you did changes in the readme file as well. 😆

Suggested change
#### Time Stamp
#### Timestamp

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since you were at it, I'd actually just format the whole section to be more concise:


A trace ID consists of two parts:

  1. Timestamp: The first 8 hexadecimal digits represent the time of the original request in Unix epoch time. For example, 10:00 AM December 1st, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal digits.
  2. Unique Identifier: The last 24 hexadecimal digits is an random identifier for the trace.

But that comes to style more than correctness.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the guidance, I updated it as such! I was not a fan of the old formatting either.


* the first 8 hexadecimal digits represent the time of the original request in Unix epoch time
* for example, 10:00AM December 1st, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal digits.
The first 8 hexadecimal digits represent the time of the original request in Unix epoch time. For example, 10:00AM December 1st, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal digits.

#### Unique Identifier

* the last 24 hexadecimal digits is an random identifier for the trace
The last 24 hexadecimal digits is an random identifier for the trace.

## Useful links

Expand Down
2 changes: 1 addition & 1 deletion propagators/opentelemetry-propagator-aws-xray/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ For additional reading, see the [AWS X-Ray Trace ID](https://docs.aws.amazon.com

* 64-bit random number in base16 format. Populated from the [OpenTelemetry Span ID](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md#spancontext).

#### Sampled - The sampling decision*
#### Sampled - The sampling decision

* Defined in the AWS X-Ray specification as a tri-state field, with "0", "1" and "?" as valid values. Only "0" and "1" are used in this propagator. If "?", a new trace will be started.
* Populated from the [OpenTelemetry trace flags](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md#spancontext).
Expand Down