Create documents for local testing by andrewqian2001datadog · Pull Request #845 · DataDog/datadogpy

andrewqian2001datadog · 2024-08-05T17:31:16Z

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

(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.

jhgilbert

Approved with some minor style and formatting suggestions, thanks!

doc/dev/testing.md

Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>

gh123man

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

doc/dev/testing.md

gh123man · 2024-08-07T18:41:44Z

doc/dev/testing.md

+
+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


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 · 2024-09-07T05:05:54Z

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.

Co-authored-by: Brian Floersch <gh123man@gmail.com>

jhgilbert

Approved with a few suggestions, thanks!

doc/dev/testing.md

Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>

github-actions · 2024-10-19T05:06:04Z

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.

Create documents for local testing

b0d3c31

github-actions bot added the documentation Documentation related changes label Aug 5, 2024

andrewqian2001datadog self-assigned this Aug 5, 2024

andrewqian2001datadog requested a review from gh123man August 5, 2024 17:37

andrewqian2001datadog marked this pull request as ready for review August 5, 2024 17:38

andrewqian2001datadog requested review from a team as code owners August 5, 2024 17:38

andrewqian2001datadog added the changelog/no-changelog Changes don't appear in changelog label Aug 5, 2024

jhgilbert self-requested a review August 5, 2024 20:13

jhgilbert previously approved these changes Aug 5, 2024

View reviewed changes

Update doc/dev/testing.md

310adbe

Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>

andrewqian2001datadog dismissed jhgilbert’s stale review via 310adbe August 6, 2024 17:50

andrewqian2001datadog and others added 7 commits August 6, 2024 13:50

Update doc/dev/testing.md

6890aa7

Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>

Update doc/dev/testing.md

d7ad09b

Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>

Update doc/dev/testing.md

111a8f4

Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>

Update doc/dev/testing.md

7473069

Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>

Update doc/dev/testing.md

a27fb3e

Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>

Address all comments

be87fd2

Woops missed a change

8391471

gh123man requested changes Aug 7, 2024

View reviewed changes

github-actions bot added the stale Stale - Bot reminder label Sep 7, 2024

andrewqian2001datadog and others added 3 commits September 9, 2024 09:48

Update doc/dev/testing.md

c582728

Co-authored-by: Brian Floersch <gh123man@gmail.com>

Update doc/dev/testing.md

e2e4656

Co-authored-by: Brian Floersch <gh123man@gmail.com>

Update docs with requested changes

9bc3463

andrewqian2001datadog removed the stale Stale - Bot reminder label Sep 9, 2024

andrewqian2001datadog requested review from gh123man and jhgilbert September 9, 2024 14:22

jhgilbert previously approved these changes Sep 13, 2024

View reviewed changes

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

Update doc/dev/testing.md

0defd5d

Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>

andrewqian2001datadog dismissed jhgilbert’s stale review via 0defd5d September 18, 2024 17:37

andrewqian2001datadog and others added 2 commits September 18, 2024 13:37

Update doc/dev/testing.md

ec7f2b1

Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>

Update doc/dev/testing.md

1c53f0e

Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>

github-actions bot added the stale Stale - Bot reminder label Oct 19, 2024


		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

Conversation

andrewqian2001datadog commented Aug 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Description of the Change

Verification Process

Additional Notes

Release Notes

Review checklist (to be filled by reviewers)

Uh oh!

jhgilbert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gh123man left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gh123man Aug 7, 2024

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Sep 7, 2024

Uh oh!

jhgilbert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Oct 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

andrewqian2001datadog commented Aug 5, 2024 •

edited

Loading