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

Update readme #421

Merged
merged 3 commits into from
Oct 11, 2019
Merged

Update readme #421

merged 3 commits into from
Oct 11, 2019

Conversation

mayurkale22
Copy link
Member

Which problem is this PR solving?

  • Add Web and Metrics SDK links.

  • Add work in progress Exporter(prometheus) and plugin(postgres).

@codecov-io
Copy link

codecov-io commented Oct 10, 2019

Codecov Report

Merging #421 into master will increase coverage by 0.19%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #421      +/-   ##
==========================================
+ Coverage   95.59%   95.79%   +0.19%     
==========================================
  Files         108      108              
  Lines        5042     5162     +120     
  Branches      419      408      -11     
==========================================
+ Hits         4820     4945     +125     
+ Misses        222      217       -5
Impacted Files Coverage Δ
packages/opentelemetry-core/src/common/time.ts 92.68% <0%> (-3.93%) ⬇️
...ages/opentelemetry-plugin-http/test/utils/utils.ts 57.14% <0%> (-2.86%) ⬇️
...ckages/opentelemetry-core/src/common/NoopLogger.ts 40% <0%> (-2.86%) ⬇️
...core/src/context/propagation/BinaryTraceContext.ts 96.15% <0%> (-2.21%) ⬇️
...telemetry-core/src/context/propagation/B3Format.ts 94.59% <0%> (-1.33%) ⬇️
...entelemetry-core/test/common/ConsoleLogger.test.ts 100% <0%> (ø) ⬆️
packages/opentelemetry-tracing/src/config.ts 100% <0%> (ø) ⬆️
packages/opentelemetry-tracing/src/utility.ts 100% <0%> (ø) ⬆️
...ges/opentelemetry-exporter-zipkin/src/transform.ts 100% <0%> (ø) ⬆️
...core/src/context/propagation/NoopHttpTextFormat.ts 100% <0%> (ø) ⬆️
... and 30 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6481e3d...9994eeb. Read the comment docs.

Copy link
Member

@dyladan dyladan left a comment

Choose a reason for hiding this comment

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

Looks good. Just a few small wording nitpicks.

README.md Outdated
- [@opentelemetry/exporter-jaeger](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-exporter-jaeger)
- [@opentelemetry/exporter-zipkin](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-exporter-zipkin)

#### Metrics Exporters
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
#### Metrics Exporters
#### Metric Exporters

README.md Outdated
@@ -53,22 +53,29 @@ We have a weekly SIG meeting! See the [community page](https://github.com/open-t
| Package | Description |
| ----------------------- | -----------------|
| [@opentelemetry/tracing](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-tracing) | This module provides a full control over instrumentation and span creation. It doesn't load [`async_hooks`](https://nodejs.org/api/async_hooks.html) or any instrumentation plugin by default. It is intended for use both on the server and in the browser. |
| [@opentelemetry/metrics](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-metrics) | This module allows to report raw measurements as well as metrics with the known aggregation and labels. |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| [@opentelemetry/metrics](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-metrics) | This module allows to report raw measurements as well as metrics with the known aggregation and labels. |
| [@opentelemetry/metrics](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-metrics) | This module provides instruments and meters for reporting of time series data. |

README.md Outdated
| [@opentelemetry/node](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node) | This module provides automatic tracing for Node.js applications. It is intended for use on the server only. |
| [@opentelemetry/web](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-web) | This module provides automated instrumentation and tracing for Web applications. |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| [@opentelemetry/web](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-web) | This module provides automated instrumentation and tracing for Web applications. |
| [@opentelemetry/web](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-web) | This module provides automated instrumentation and tracing for Web applications. It is intended for use in the browser only. |

@mayurkale22 mayurkale22 merged commit 8b20e41 into open-telemetry:master Oct 11, 2019
@mayurkale22 mayurkale22 deleted the update_readme branch October 11, 2019 17:00
pichlermarc pushed a commit to dynatrace-oss-contrib/opentelemetry-js that referenced this pull request Dec 15, 2023
* feat: add xray propagator

* chore: cleanups

* Remove AWS Distro link

Co-authored-by: Valentin Marchaud <[email protected]>
martinkuba pushed a commit to martinkuba/opentelemetry-js that referenced this pull request Mar 13, 2024
* feat: add xray propagator

* chore: cleanups

* Remove AWS Distro link

Co-authored-by: Valentin Marchaud <[email protected]>
martinkuba pushed a commit to martinkuba/opentelemetry-js that referenced this pull request Apr 2, 2024
* feat: add xray propagator

* chore: cleanups

* Remove AWS Distro link

Co-authored-by: Valentin Marchaud <[email protected]>
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.

5 participants