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(grpc-exporters): remove 'web' as supported from README.md #3070

Merged

Conversation

pichlermarc
Copy link
Member

Which problem is this PR solving?

The gRPC exporters for both trace and metrics listed 'web and node' as supported targets, but only 'node' is actually supported.
This PR removes 'web' from the respective README.mds.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • Followed the style guidelines of this project
  • Unit tests have been added
  • Documentation has been updated

@pichlermarc pichlermarc marked this pull request as ready for review June 29, 2022 17:01
@pichlermarc pichlermarc requested a review from a team June 29, 2022 17:01
@codecov
Copy link

codecov bot commented Jun 29, 2022

Codecov Report

Merging #3070 (44b9b74) into main (6eca6d4) will decrease coverage by 0.41%.
The diff coverage is n/a.

❗ Current head 44b9b74 differs from pull request most recent head 75c8e83. Consider uploading reports for the commit 75c8e83 to get more accurate results

@@            Coverage Diff             @@
##             main    #3070      +/-   ##
==========================================
- Coverage   93.08%   92.66%   -0.42%     
==========================================
  Files         188      173      -15     
  Lines        6261     5523     -738     
  Branches     1323     1175     -148     
==========================================
- Hits         5828     5118     -710     
+ Misses        433      405      -28     
Impacted Files Coverage Δ
packages/opentelemetry-resources/karma.worker.js 0.00% <0.00%> (-100.00%) ⬇️
...kages/opentelemetry-sdk-trace-base/karma.worker.js 0.00% <0.00%> (-100.00%) ⬇️
...lemetry-resources/src/detectors/BrowserDetector.ts 53.33% <0.00%> (-46.67%) ⬇️
...lemetry-resources/src/detectors/ProcessDetector.ts 95.45% <0.00%> (-4.55%) ⬇️
...emetry-instrumentation-xml-http-request/src/xhr.ts
...-sdk-trace-web/src/enums/PerformanceTimingNames.ts
...ry-context-zone-peer-dep/src/ZoneContextManager.ts
packages/opentelemetry-sdk-trace-web/src/types.ts
...telemetry-sdk-trace-web/src/StackContextManager.ts
packages/opentelemetry-sdk-trace-web/src/utils.ts
... and 9 more

@@ -3,7 +3,7 @@
[![NPM Published Version][npm-img]][npm-url]
[![Apache License][license-image]][license-image]

This module provides exporter for web and node to be used with [opentelemetry-collector][opentelemetry-collector-url].
This module provides exporter for node to be used with [opentelemetry-collector][opentelemetry-collector-url].
Copy link
Member

Choose a reason for hiding this comment

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

Not related to this fix, but I think the wording should be "OTLP receiver" instead of "opentelemetry-collector", since the exporter can send to any OTLP compatible receiver.

Copy link
Member

Choose a reason for hiding this comment

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

Probably in other packages as well. Anyway, just sharing a thought. I can open a separate PR after this one is merged.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, that makes sense. 🙂
Since this PR is already approved I can also do it in a follow-up if you like.

@pichlermarc pichlermarc changed the title docs(grpc-exporters): remove 'web' as supported from README.md. docs(grpc-exporters): remove 'web' as supported from README.md Jun 30, 2022
experimental/CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>
@dyladan dyladan added the document Documentation-related label Jun 30, 2022
@dyladan dyladan merged commit 6dd6af3 into open-telemetry:main Jun 30, 2022
@dyladan dyladan deleted the update-exporter-docs branch June 30, 2022 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document Documentation-related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants