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: Update example apps #86

Merged
merged 7 commits into from
Feb 16, 2023
Merged

docs: Update example apps #86

merged 7 commits into from
Feb 16, 2023

Conversation

pkanal
Copy link
Contributor

@pkanal pkanal commented Feb 15, 2023

Which problem is this PR solving?

Short description of the changes

  • Added metrics example
  • Added local visualizations to flask example
  • Added all options available with descriptions to basic example
  • Reorganized readmes a bit and added some more details to example READMEs

How to verify that this has the expected result

  • Configure a metrics dataset and run the flask app, verify that you see metrics in Honeycomb
  • Run basic app and click on local vis link

@pkanal pkanal added the version: no bump A PR with maintenance or doc changes that aren't included in a release. label Feb 15, 2023
@pkanal pkanal requested a review from a team February 15, 2023 19:19
@pkanal pkanal self-assigned this Feb 15, 2023
Comment on lines +11 to +20
# traces_apikey = None, Set a specific Honeycomb API key just for traces
# metrics_apikey = None, Set a specific Honeycomb API key just for metrics
# service_version = None, Set a version for this service, will show up as an attribute on all spans
# traces_endpoint = None, Set a specific exporter endpoint just for traces
# metrics_endpoint = None, Set a specific exporter endpoint just for metrics
# exporter_protocol = "grpc", Set the exporter protocol, grpc or http/protobuf
# traces_exporter_protocol = "grpc", Set a specific exporter protocol just for traces, grpc or http/protobuf
# metrics_exporter_protocol = "grpc", Set a specific exporter protocol just for metrics, grpc or http/protobuf
# sample_rate = DEFAULT_SAMPLE_RATE, Set a sample rate for spans
# metrics_dataset = None, Set a metrics dataset to enable metrics
Copy link
Contributor

Choose a reason for hiding this comment

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

🤩

Copy link
Contributor

@JamieDanielson JamieDanielson left a comment

Choose a reason for hiding this comment

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

This is great; I especially like the commented out options in the example app.

As part of this cleanup, can we also do a couple more formatting adjustments? I suggested a few things here that are either squigglies or just trying to auto-format in my editor, and this seems like the right moment to hit it.

examples/hello-world-flask/README.md Show resolved Hide resolved
examples/hello-world-flask/app.py Outdated Show resolved Hide resolved
pkanal and others added 3 commits February 16, 2023 12:13
Co-authored-by: Jamie Danielson <jamieedanielson@gmail.com>
…ycomb-opentelemetry-python into purvi/example-app-audit
@pkanal pkanal merged commit 3c91a7c into main Feb 16, 2023
@pkanal pkanal deleted the purvi/example-app-audit branch February 16, 2023 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
version: no bump A PR with maintenance or doc changes that aren't included in a release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[dev/user] audit of example app as an illustrative example of use
2 participants