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: create a getting started guide #566

Merged

Conversation

dyladan
Copy link
Member

@dyladan dyladan commented Nov 23, 2019

Which problem is this PR solving?

What have you done

Tracing

  • zipkin setup
  • configure tracing
  • export traces

Metrics

  • prometheus setup
  • configure metrics collection
  • export metrics

See the guide in its current form here https://github.com/dynatrace-oss-contrib/opentelemetry-js/blob/getting-started/getting-started/Getting-Started.md

@codecov-io
Copy link

codecov-io commented Nov 23, 2019

Codecov Report

Merging #566 into master will decrease coverage by <.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #566      +/-   ##
==========================================
- Coverage   90.12%   90.12%   -0.01%     
==========================================
  Files         150      149       -1     
  Lines        7381     7400      +19     
  Branches      667      669       +2     
==========================================
+ Hits         6652     6669      +17     
- Misses        729      731       +2
Impacted Files Coverage Δ
...kages/opentelemetry-plugin-dns/test/utils/utils.ts 33.33% <0%> (-26.67%) ⬇️
...ry-scope-async-hooks/src/AsyncHooksScopeManager.ts 97.67% <0%> (ø) ⬆️
packages/opentelemetry-tracing/src/BasicTracer.ts 100% <0%> (ø) ⬆️
...elemetry-tracing/src/export/ConsoleSpanExporter.ts 85.71% <0%> (ø) ⬆️
...es/opentelemetry-node/src/instrumentation/utils.ts 90.47% <0%> (-9.53%) ⬇️
...es/opentelemetry-plugin-document-load/src/utils.ts 100% <0%> (ø) ⬆️
packages/opentelemetry-tracing/src/Span.ts 100% <0%> (ø) ⬆️
packages/opentelemetry-metrics/src/Utils.ts 100% <0%> (ø) ⬆️
...res/opentelemetry-plugin-pg/test/assertionUtils.ts 96.29% <0%> (-3.71%) ⬇️
...y-plugin-document-load/src/enums/AttributeNames.ts 100% <0%> (ø) ⬆️
... and 50 more

Copy link
Member

@mayurkale22 mayurkale22 left a comment

Choose a reason for hiding this comment

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

Overall lgtm

getting-started/Getting-Started.md Show resolved Hide resolved
Copy link
Member

@mayurkale22 mayurkale22 left a comment

Choose a reason for hiding this comment

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

LGTM, added 2 minor comments

getting-started/example/app.js Outdated Show resolved Hide resolved
getting-started/traced-example/tracing.js Outdated Show resolved Hide resolved
@danielkhan danielkhan merged commit 66927ce into open-telemetry:master Nov 25, 2019
@dyladan dyladan deleted the getting-started branch November 25, 2019 18:08
pichlermarc pushed a commit to dynatrace-oss-contrib/opentelemetry-js that referenced this pull request Dec 15, 2023
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.

4 participants