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

Create documents for local testing #845

Open
wants to merge 15 commits into
base: master
Choose a base branch
from

Conversation

andrewqian2001datadog
Copy link
Contributor

@andrewqian2001datadog andrewqian2001datadog commented Aug 5, 2024

What does this PR do?

Adds documentation for setting up the testing environment and sending logs to the agent.

Description of the Change

Commands for setting up local testing environment

Verification Process

Cloned a new repo of datadogpy and performed the actions specified in the document,

Additional Notes

One of the previous commands I ran during the first time we set up local testing gave an error

(.venv) ➜  datadogpy git:(master) ✗ pip install unittest
ERROR: Could not find a version that satisfies the requirement unittest (from versions: none)
ERROR: No matching distribution found for unittest

I don't think we need to run this command
image
(source)

Release Notes

Review checklist (to be filled by reviewers)

  • Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have one changelog/ label attached. If applicable it should have the backward-incompatible label attached.
  • PR should not have do-not-merge/ label attached.
  • If Applicable, issue must have kind/ and severity/ labels attached at least.

@github-actions github-actions bot added the documentation Documentation related changes label Aug 5, 2024
@andrewqian2001datadog andrewqian2001datadog self-assigned this Aug 5, 2024
@andrewqian2001datadog andrewqian2001datadog marked this pull request as ready for review August 5, 2024 17:38
@andrewqian2001datadog andrewqian2001datadog added the changelog/no-changelog Changes don't appear in changelog label Aug 5, 2024
@jhgilbert jhgilbert self-requested a review August 5, 2024 20:13
jhgilbert
jhgilbert previously approved these changes Aug 5, 2024
Copy link
Contributor

@jhgilbert jhgilbert left a comment

Choose a reason for hiding this comment

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

Approved with some minor style and formatting suggestions, thanks!

doc/dev/testing.md Outdated Show resolved Hide resolved
doc/dev/testing.md Outdated Show resolved Hide resolved
doc/dev/testing.md Outdated Show resolved Hide resolved
doc/dev/testing.md Outdated Show resolved Hide resolved
doc/dev/testing.md Outdated Show resolved Hide resolved
doc/dev/testing.md Outdated Show resolved Hide resolved
doc/dev/testing.md Outdated Show resolved Hide resolved
doc/dev/testing.md Outdated Show resolved Hide resolved
doc/dev/testing.md Outdated Show resolved Hide resolved
doc/dev/testing.md Outdated Show resolved Hide resolved
Co-authored-by: Jen Gilbert <[email protected]>
Copy link
Member

@gh123man gh123man left a comment

Choose a reason for hiding this comment

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

Very minor suggestions. Thanks for putting this together! :)

doc/dev/testing.md Outdated Show resolved Hide resolved
doc/dev/testing.md Outdated Show resolved Hide resolved

Inside the `main.py` file that you just created, run the debugger to send logs to the agent.

Those logs should appear in the [Log Explorer](https://dddev.datadoghq.com/logs?query=&agg_m=count&agg_m_source=base&agg_t=count&cols=host%2Cservice&fromUser=true&messageDisplay=inline&refresh_mode=sliding&storage=hot&stream_sort=desc&viz=stream&from_ts=1722966102377&to_ts=1722967002377&live=true) in Datadog
Copy link
Member

Choose a reason for hiding this comment

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

Let's remove this line. It links to an internal org that external contributors cant view. (also this doc refers mostly to metrics, and this points to the logs explorer)

Copy link

github-actions bot commented Sep 7, 2024

This issue has been automatically marked as stale because it has not had activity in the last 30 days.
Note that the issue will not be automatically closed, but this notification will remind us to investigate why there's been inactivity.

@github-actions github-actions bot added the stale Stale - Bot reminder label Sep 7, 2024
@andrewqian2001datadog andrewqian2001datadog removed the stale Stale - Bot reminder label Sep 9, 2024
jhgilbert
jhgilbert previously approved these changes Sep 13, 2024
Copy link
Contributor

@jhgilbert jhgilbert left a comment

Choose a reason for hiding this comment

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

Approved with a few suggestions, thanks!

doc/dev/testing.md Outdated Show resolved Hide resolved
doc/dev/testing.md Outdated Show resolved Hide resolved
doc/dev/testing.md Outdated Show resolved Hide resolved
Co-authored-by: Jen Gilbert <[email protected]>
Copy link

This issue has been automatically marked as stale because it has not had activity in the last 30 days.
Note that the issue will not be automatically closed, but this notification will remind us to investigate why there's been inactivity.

@github-actions github-actions bot added the stale Stale - Bot reminder label Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog Changes don't appear in changelog documentation Documentation related changes stale Stale - Bot reminder
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants