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

maint: Add Django example #176

Merged
merged 2 commits into from
Feb 14, 2024
Merged

maint: Add Django example #176

merged 2 commits into from
Feb 14, 2024

Conversation

MikeGoldsmith
Copy link
Contributor

@MikeGoldsmith MikeGoldsmith commented Feb 6, 2024

Which problem is this PR solving?

Adds a Django example for users of that ecosystem to reference.

Short description of the changes

  • Adds new hello-world-django example to /examples
  • Adds links to both flask and django examples in root readme

How to verify that this has the expected result

Some can use the django example to better understand and use this distro.

@MikeGoldsmith MikeGoldsmith added the type: maintenance The necessary chores to keep the dust off. label Feb 6, 2024
@MikeGoldsmith MikeGoldsmith self-assigned this Feb 6, 2024
@MikeGoldsmith MikeGoldsmith requested a review from a team as a code owner February 6, 2024 13:15
@MikeGoldsmith MikeGoldsmith merged commit b0ef430 into main Feb 14, 2024
3 checks passed
@MikeGoldsmith MikeGoldsmith deleted the mike/django-docs branch February 14, 2024 15:43
Copy link
Member

@robbkidd robbkidd left a comment

Choose a reason for hiding this comment

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

Some corrections to the README for a follow-up PR.

## Distro Instrumentation Example

This app uses configuration configures the OpenTelemetry SDK programmatically in [manage.py](./manage.py).
Alternitively, you can use environment variables as parameters like below:
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
Alternitively, you can use environment variables as parameters like below:
Alternatively, you can use environment variables as parameters like below:

To send to Honeycomb, set your API Key:

```bash
HONEYCOMB_API_KEY="your-api-key" poetry run python3 app.py
Copy link
Member

Choose a reason for hiding this comment

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

Update this example command to use the same as earlier in this README for the django app.

Suggested change
HONEYCOMB_API_KEY="your-api-key" poetry run python3 app.py
HONEYCOMB_API_KEY="your-api-key" poetry run python manage.py runserver

MikeGoldsmith added a commit that referenced this pull request Feb 15, 2024
## Which problem is this PR solving?
Fixes a couple of typos in the Django example added in the following PR:
- #176 

## Short description of the changes
- Fix typos
- Update run command to match previous example

## How to verify that this has the expected result
Django example doesn't contain typos and commands execute as expected.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: maintenance The necessary chores to keep the dust off.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Django docs
3 participants