Skip to content

Create documents for local testing #845

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
Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open

Create documents for local testing #845

wants to merge 15 commits into from

Conversation

@andrewqian2001datadog
Copy link
Contributor

@andrewqian2001datadog andrewqian2001datadog commented Aug 5, 2024 •
edited
Loading

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 requested review from a team as code owners 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
View reviewed changes
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!

@andrewqian2001datadog @jhgilbert
Update doc/dev/testing.md
310adbe 
Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>
andrewqian2001datadog and others added 7 commits August 6, 2024 13:50
@andrewqian2001datadog @jhgilbert
Update doc/dev/testing.md
6890aa7 
Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>
@andrewqian2001datadog @jhgilbert
Update doc/dev/testing.md
d7ad09b 
Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>
@andrewqian2001datadog @jhgilbert
Update doc/dev/testing.md
111a8f4 
Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>
@andrewqian2001datadog @jhgilbert
Update doc/dev/testing.md
7473069 
Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>
@andrewqian2001datadog @jhgilbert
Update doc/dev/testing.md
a27fb3e 
Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>
@andrewqian2001datadog
Address all comments
be87fd2
@andrewqian2001datadog
Woops missed a change
8391471
gh123man
gh123man requested changes Aug 7, 2024
View reviewed changes
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

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

@gh123man gh123man Aug 7, 2024

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)

@github-actions
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 and others added 3 commits September 9, 2024 09:48
@andrewqian2001datadog @gh123man
Update doc/dev/testing.md
c582728 
Co-authored-by: Brian Floersch <gh123man@gmail.com>
@andrewqian2001datadog @gh123man
Update doc/dev/testing.md
e2e4656 
Co-authored-by: Brian Floersch <gh123man@gmail.com>
@andrewqian2001datadog
Update docs with requested changes
9bc3463
@andrewqian2001datadog andrewqian2001datadog removed the stale Stale - Bot reminder label Sep 9, 2024
jhgilbert
jhgilbert previously approved these changes Sep 13, 2024
View reviewed changes
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!

@andrewqian2001datadog @jhgilbert
Update doc/dev/testing.md
0defd5d 
Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>
andrewqian2001datadog and others added 2 commits September 18, 2024 13:37
@andrewqian2001datadog @jhgilbert
Update doc/dev/testing.md
ec7f2b1 
Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>
@andrewqian2001datadog @jhgilbert
Update doc/dev/testing.md
1c53f0e 
Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>
@github-actions
Copy link

github-actions bot commented Oct 19, 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 Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jhgilbert jhgilbert jhgilbert left review comments

@gh123man gh123man Awaiting requested review from gh123man

Requested changes must be addressed to merge this pull request.

Assignees

@andrewqian2001datadog andrewqian2001datadog

Labels

changelog/no-changelog Changes don't appear in changelog documentation Documentation related changes stale Stale - Bot reminder

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@andrewqian2001datadog @gh123man @jhgilbert