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.

Sign up for GitHub

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

Jump to bottom

Improve docs around auto and manual SDK configuration options #57

Closed
Tracked by #3
MikeGoldsmith opened this issue Jan 18, 2023 · 1 comment · Fixed by #105
Closed
Tracked by #3

Improve docs around auto and manual SDK configuration options #57

MikeGoldsmith opened this issue Jan 18, 2023 · 1 comment · Fixed by #105
Labels
type: enhancement New feature or request
Milestone
Beta

Comments

@MikeGoldsmith
Copy link
Contributor

Ensure docs describe both auto and manual SDK configuration using the distro.

For example:

  • Auto instrumentation with opentelemetry-instrument
  • Manual configuration with configure_opentelemetry

Note: our hello-world-flask example only show auto instrumentation.
@MikeGoldsmith MikeGoldsmith added the type: enhancement New feature or request label Jan 18, 2023
@MikeGoldsmith MikeGoldsmith added this to the Beta milestone Jan 18, 2023
@MikeGoldsmith MikeGoldsmith mentioned this issue Jan 18, 2023
Merged
@emilyashley emilyashley mentioned this issue Feb 14, 2023
Closed
4 tasks
@emilyashley emilyashley mentioned this issue Mar 1, 2023
Closed
33 tasks
@emilyashley
Copy link
Contributor

note: clarify this --> https://github.com/honeycombio/honeycomb-opentelemetry-python/blob/main/examples/hello-world/app.py#L31

@emilyashley emilyashley mentioned this issue Mar 2, 2023
Merged
emilyashley added a commit that referenced this issue Mar 6, 2023
@emilyashley
doc: clarify SDK configuration options (command vs function) and fina…
d6beb27 
…l developing.md & readme.md audits (#105)

<!--
Thank you for contributing to the project! 💜
Please see our [OSS process
document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#)
to get an idea of how we operate.
-->

## Which problem is this PR solving?

- Closes #57 
- Closes #77 

## Short description of the changes
- Created an examples overview 
- Comments to smoke tests re: testing both configure_opentelemetry() and
opentelemetry_instrument
- Moved example development notes to developing.md
- Left additional breadcrumbs for others to use the smoke-test
docker-compose for running examples with collector should they so choose

## How to verify that this has the expected result
All the links in the readme's work.
Finding information about example usage is clear.
It's clear there are two ways to use the distro:
configure_opentelemetry() or opentelemetry_instrument

Note: This is probably best reviewed by viewing the readme's in the
[repo
view](https://github.com/honeycombio/honeycomb-opentelemetry-python/tree/emash-config-vs-command)
rather than the .md diffs :)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: enhancement New feature or request
Projects
None yet
Milestone
Beta
2 participants
@MikeGoldsmith @emilyashley