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

docs: add instrumentation quickstart sample #687

Merged
merged 2 commits into from
Mar 25, 2024

Conversation

aabmass
Copy link
Contributor

@aabmass aabmass commented Mar 21, 2024

This is clone of the existing Go and Java samples. I decided to use Fastify because the instrumentation produces nice traces compared to express, it is popular, and has builtin logging with Pino.

I've excluded the sample from the npm workspace which makes it independent from the rest of the repo instead of a "subpackage".

Output of running it in Cloud Shell:
image

Screenshot 2024-03-21 at 12 33 44 PM

@aabmass aabmass changed the title docs: OTel quickstart showing auto instrumentation of an express app docs: add OTel quickstart Mar 21, 2024
Copy link

codecov bot commented Mar 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.72%. Comparing base (f9a5c8b) to head (2e272fa).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #687   +/-   ##
=======================================
  Coverage   97.72%   97.72%           
=======================================
  Files          18       18           
  Lines         703      703           
  Branches      136      136           
=======================================
  Hits          687      687           
  Misses         16       16           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@aabmass aabmass force-pushed the quickstart branch 6 times, most recently from fcd2774 to ef19fa3 Compare March 21, 2024 15:44
@aabmass aabmass changed the title docs: add OTel quickstart docs: add instrumentation quickstart sample Mar 21, 2024
@aabmass aabmass marked this pull request as ready for review March 21, 2024 15:48
@aabmass aabmass requested a review from a team as a code owner March 21, 2024 15:48
@aabmass aabmass force-pushed the quickstart branch 2 times, most recently from d6de111 to 562c3bc Compare March 21, 2024 16:02
Copy link

snippet-bot bot commented Mar 21, 2024

Here is the summary of changes.

You are about to add 6 region tags.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

aabmass added a commit to aabmass/opentelemetry-operations-java that referenced this pull request Mar 21, 2024
The `opentelemetry_instrumentation_agent_dockerfile` region tag is more general and can be referenced across different languages. I am using the same one for JS in GoogleCloudPlatform/opentelemetry-operations-js#687

I have "pinned" the docs build to existing version to prevent breaking links in the docs.
aabmass added a commit to GoogleCloudPlatform/opentelemetry-operations-java that referenced this pull request Mar 21, 2024
The `opentelemetry_instrumentation_agent_dockerfile` region tag is more general and can be referenced across different languages. I am using the same one for JS in GoogleCloudPlatform/opentelemetry-operations-js#687

I have "pinned" the docs build to existing version to prevent breaking links in the docs.
Copy link
Contributor

@dashpole dashpole left a comment

Choose a reason for hiding this comment

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

Does this set the http.route?

Copy link
Contributor Author

@aabmass aabmass left a comment

Choose a reason for hiding this comment

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

Yes it has http.route. It's in metrics too, see the screenshot above.
image

samples/instrumentation-quickstart/README.md Show resolved Hide resolved
samples/instrumentation-quickstart/docker-compose.yaml Outdated Show resolved Hide resolved
Co-authored-by: David Ashpole <dashpole@google.com>
@aabmass aabmass requested a review from dashpole March 22, 2024 20:34
@aabmass aabmass merged commit 0bfeaf3 into GoogleCloudPlatform:main Mar 25, 2024
21 checks passed
@aabmass aabmass deleted the quickstart branch March 25, 2024 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants