-
Notifications
You must be signed in to change notification settings - Fork 315
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.
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
Open
andrewqian2001datadog
wants to merge
15
commits into
master
Choose a base branch
from
andrewqian2001datadog-local-testing-docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 9 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
b0d3c31
Create documents for local testing
andrewqian2001datadog 310adbe
Update doc/dev/testing.md
andrewqian2001datadog 6890aa7
Update doc/dev/testing.md
andrewqian2001datadog d7ad09b
Update doc/dev/testing.md
andrewqian2001datadog 111a8f4
Update doc/dev/testing.md
andrewqian2001datadog 7473069
Update doc/dev/testing.md
andrewqian2001datadog a27fb3e
Update doc/dev/testing.md
andrewqian2001datadog be87fd2
Address all comments
andrewqian2001datadog 8391471
Woops missed a change
andrewqian2001datadog c582728
Update doc/dev/testing.md
andrewqian2001datadog e2e4656
Update doc/dev/testing.md
andrewqian2001datadog 9bc3463
Update docs with requested changes
andrewqian2001datadog 0defd5d
Update doc/dev/testing.md
andrewqian2001datadog ec7f2b1
Update doc/dev/testing.md
andrewqian2001datadog 1c53f0e
Update doc/dev/testing.md
andrewqian2001datadog File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| # Setting up a local testing environment | ||
|
|
||
| ### Install dependencies | ||
| Inside the repo, set up a virtual environment and install dependencies from the command line: | ||
| * `python -m venv .venv` | ||
| * `source .venv/bin/activate` | ||
| * `pip install -e .` | ||
| * `pip install pytest` | ||
| * `pip install mock` | ||
|
|
||
| ### Create config files | ||
| Create a folder called `./vscode`. | ||
| Inside the folder, create a file called `launch.json` with the following settings: | ||
| ``` | ||
| { | ||
| // Use IntelliSense to learn about possible attributes. | ||
| // Hover to view descriptions of existing attributes. | ||
| // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 | ||
| "version": "0.2.0", | ||
| "configurations": [ | ||
| { | ||
| "name": "Python Debugger: Current File", | ||
| "type": "debugpy", | ||
| "request": "launch", | ||
| "program": "${file}", | ||
| "console": "integratedTerminal" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
| Create a file called `settings.json` with the following settings: | ||
| ``` | ||
| { | ||
| "python.testing.unittestArgs": [ | ||
| "-v", | ||
| "-s", | ||
| "./tests", | ||
| "-p", | ||
| "test_*.py" | ||
| ], | ||
| "python.testing.pytestEnabled": false, | ||
| "python.testing.unittestEnabled": true | ||
| } | ||
| ``` | ||
| ### Run unit tests locally in VS Code | ||
| You should now be able to run the unit tests locally: | ||
|
|
||
| <img width="604" alt="image" src="https://github.com/user-attachments/assets/ea5c74c5-ee56-4fc3-83c8-73a00c9cab1e"> | ||
|
|
||
| ### Send logs to the agent | ||
andrewqian2001datadog marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Create a folder for testing, such as `testapp/main.py`. Create a file inside the folder with the following code: | ||
| ``` | ||
| from datadog import initialize, statsd | ||
| import time | ||
|
|
||
| options = { | ||
| "statsd_host": "127.0.0.1", | ||
| "statsd_port": 8125, | ||
| } | ||
|
|
||
| initialize(**options) | ||
|
|
||
|
|
||
| while(1): | ||
| statsd.increment('example_metric.increment', tags=["environment:dev"]) | ||
| statsd.decrement('example_metric.decrement', tags=["environment:dev"]) | ||
| time.sleep(10) | ||
| ``` | ||
|
|
||
| [Install the Agent](https://github.com/DataDog/datadog-agent). | ||
|
|
||
| Run the Agent: `./bin/agent/agent run -c bin/agent/dist/datadog.yaml` | ||
|
|
||
| Inside the `main.py` file that you just created, run the debugger to send logs to the agent. | ||
andrewqian2001datadog marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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 | ||
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.