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

otlpmetricgrpc otlpmetrichttp: Add README.md #4336

Merged
merged 16 commits into from Nov 2, 2023

Conversation

MadVikingGod
Copy link
Contributor

This is a first pass at adding a readme to the otlpmetric exporter.

It is mostly a copy of the otlptrace readme. The attempt is to make this look presentable in github's markdown, and in pkg.go.dev.

@MadVikingGod MadVikingGod added documentation Provides helpful information area:metrics Part of OpenTelemetry Metrics Skip Changelog PRs that do not require a CHANGELOG.md entry labels Jul 18, 2023
exporters/otlp/otlpmetric/readme.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/readme.md Outdated Show resolved Hide resolved
Copy link
Member

@pellared pellared left a comment

Choose a reason for hiding this comment

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

nit (general comment): What do you think of adding (almost the same) README.md for otlpmetrichttp and otlpmetricgrpc directories instead?

exporters/otlp/otlpmetric/readme.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/readme.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/readme.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/readme.md Outdated Show resolved Hide resolved
Removed the unified readme.
Added make target to lint markdown locally.
@dmathieu
Copy link
Member

The filename is in lowercase, while every other readme in the repo is uppercase.

Copy link
Member

@pellared pellared left a comment

Choose a reason for hiding this comment

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

few nit comments. Nice work 👍

exporters/otlp/otlpmetric/otlpmetricgrpc/readme.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetrichttp/readme.md Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetricgrpc/readme.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetricgrpc/readme.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetricgrpc/readme.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetricgrpc/readme.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetrichttp/readme.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetrichttp/readme.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetrichttp/readme.md Outdated Show resolved Hide resolved
Copy link
Member

@pellared pellared left a comment

Choose a reason for hiding this comment

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

The description for OTEL_EXPORTER_OTLP_TRACES_* are missing.

exporters/otlp/otlpmetric/otlpmetricgrpc/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetrichttp/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetricgrpc/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetricgrpc/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetricgrpc/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetricgrpc/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetricgrpc/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetricgrpc/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetrichttp/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetrichttp/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetrichttp/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetrichttp/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetrichttp/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetrichttp/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetrichttp/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetricgrpc/README.md Outdated Show resolved Hide resolved
@MrAlias MrAlias added the pkg:exporter:otlp Related to the OTLP exporter package label Sep 14, 2023
Co-authored-by: Robert Pająk <pellared@hotmail.com>
@MadVikingGod
Copy link
Contributor Author

The description for OTEL_EXPORTER_OTLP_TRACES_* are missing.

Yes, I have not included any of the Trace environment variables in the Metrics documentation PR.

Copy link
Member

@pellared pellared left a comment

Choose a reason for hiding this comment

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

We default to HTTPS (secure). Reference: #4147 😬

Should we also call out that WithEndpoint accepts a "hostname" and not an URL like the env vars? Reference #3730

exporters/otlp/otlpmetric/otlpmetricgrpc/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetricgrpc/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetrichttp/README.md Outdated Show resolved Hide resolved
exporters/otlp/otlpmetric/otlpmetrichttp/README.md Outdated Show resolved Hide resolved
@pellared
Copy link
Member

@MadVikingGod PTAL, I did my best to update this PR.

Copy link
Member

@pellared pellared left a comment

Choose a reason for hiding this comment

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

I found out that we can document WithURLPath

exporters/otlp/otlpmetric/otlpmetrichttp/README.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Oct 30, 2023

Codecov Report

Merging #4336 (dc5a265) into main (e3d0c50) will increase coverage by 0.0%.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #4336   +/-   ##
=====================================
  Coverage   81.7%   81.7%           
=====================================
  Files        225     225           
  Lines      18044   18044           
=====================================
+ Hits       14750   14752    +2     
+ Misses      2996    2994    -2     
  Partials     298     298           

see 1 file with indirect coverage changes

@pellared pellared changed the title Adds Readme to otlpmetric exporter otlpmetricgrpc otlpmetrichttp: Add README.md Nov 2, 2023
@pellared pellared merged commit 480edcc into open-telemetry:main Nov 2, 2023
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:metrics Part of OpenTelemetry Metrics documentation Provides helpful information pkg:exporter:otlp Related to the OTLP exporter package Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

6 participants