You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# nix profile upgrade ddapm-test-agent # to upgrade
24
24
@@ -50,7 +50,7 @@ or a specific branch:
50
50
51
51
### Trace invariant checks
52
52
53
-
Many checks are provided by the test agent which will verify trace data.
53
+
Many checks are provided by the test agent which will verify trace data.
54
54
All checks are enabled by default and can be manually disabled.
55
55
56
56
See the [configuration](#configuration) section for the options.
@@ -86,19 +86,19 @@ INFO:ddapm_test_agent.agent:end of payload -------------------------------------
86
86
87
87
### Proxy
88
88
89
-
The test agent provides proxying to the Datadog agent.
89
+
The test agent provides proxying to the Datadog agent.
90
90
This is enabled by passing the agent url to the test agent either via the `--agent-url` command-line argument or by the `DD_TRACE_AGENT_URL` or `DD_AGENT_URL` environment variables.
91
91
92
92
When proxying is enabled, the response from the Datadog agent will be returned instead of one from the test agent.
93
93
94
-
At the trace-level, proxying can also be disabled by including the `X-Datadog-Agent-Proxy-Disabled` header with a value of `true`. This will disable proxying after a trace
94
+
At the trace-level, proxying can also be disabled by including the `X-Datadog-Agent-Proxy-Disabled` header with a value of `true`. This will disable proxying after a trace
95
95
is handled, regardless of whether an agent URL is set.
96
96
97
97
98
98
### Snapshot testing
99
99
100
100
The test agent provides a form of [characterization testing](https://en.wikipedia.org/wiki/Characterization_test) which
101
-
we refer to as snapshotting.
101
+
we refer to as snapshotting.
102
102
This allows library maintainers to ensure that traces don't change unexpectedly when making unrelated changes.
103
103
104
104
This can be used to write integration tests by having test cases use the tracer to emit traces which are collected by the test agent and compared against reference traces stored previously.
@@ -129,7 +129,7 @@ The traces are normalized and output in JSON to a file. The following transforma
129
129
130
130
### Recording 3rd party API requests
131
131
132
-
The test agent can be configured to proxy requests to select provider API endpoints, capturing real requests to
132
+
The test agent can be configured to proxy requests to select provider API endpoints, capturing real requests to
133
133
the server and recording them to play back for future use. Currently, only OpenAI, Azure OpenAI, and DeepSeek are supported.
134
134
135
135
These cassettes are recorded by default in the `vcr-cassettes` directory. However, this can be changed with the `--vcr-cassettes-directory` command-line option, or `VCR_CASSETTES_DIRECTORY` environment variable.
@@ -245,8 +245,8 @@ Please refer to `ddapm-test-agent-fmt --help` for more information.
245
245
-`DD_SUPPRESS_TRACE_PARSE_ERRORS`[`false`]: Set to `"true"` to disable span parse errors when decoding handled traces. When disabled, errors will not be thrown for
246
246
metrics incorrectly placed within the meta field, or other type errors related to span tag formatting/types. Can also be set using the `--suppress-trace-parse-errors=true` option.
247
247
248
-
-`SNAPSHOT_REMOVED_ATTRS`[`""`]: The attributes to remove from spans in snapshots. This is useful for removing attributes
249
-
that are not relevant to the test case. **Note that removing `span_id` is not permitted to allow span
248
+
-`SNAPSHOT_REMOVED_ATTRS`[`""`]: The attributes to remove from spans in snapshots. This is useful for removing attributes
249
+
that are not relevant to the test case. **Note that removing `span_id` is not permitted to allow span
250
250
ordering to be maintained.**
251
251
252
252
-`SNAPSHOT_REGEX_PLACEHOLDERS`[`""`]: The regex expressions to replace by a placeholder. Expressed as a comma separated `key:value` list. Specifying `ba[rz]:placeholder` will change any occurrence of `bar` or `baz` to `{placeholder}`: `foobarbazqux` -> `foo{placeholder}{placeholder}qux`. This is in particular useful to strip path prefixes or other infrastructure dependent identifiers.
@@ -386,11 +386,11 @@ Create a Remote Config payload to retrieve in endpoint `/v0.7/config`
Due to Remote Config payload being quite complicated, this endpoint works like `/test/session/responses/config (POST)`
393
+
Due to Remote Config payload being quite complicated, this endpoint works like `/test/session/responses/config (POST)`
394
394
but you should send a path and a message and this endpoint builds the Remote Config payload.
395
395
396
396
The keys of the JSON body are `path` and `msg`
@@ -404,9 +404,9 @@ curl -X POST 'http://0.0.0.0:8126/test/session/responses/config/path' -d '{"path
404
404
405
405
406
406
### /test/trace_check/failures (GET)
407
-
Get Trace Check failures that occured. If a token is included, trace failures for only that session token are returned unless used in conjuction with `return_all`, which can be used to return all failures regardless of inputted token. This method returns a `<Response 200>` if no Trace Check failures are being returned and a `<Response 400>` if Trace Check failures are being returned. Trace Check failures are returned as a content type of text, with failure messages concatenated in the response body. Optionally, set the `use_json` query string parameter to `true` to return Trace Check failures as a JSON response in the following format:
407
+
Get Trace Check failures that occured. If a token is included, trace failures for only that session token are returned unless used in conjuction with `return_all`, which can be used to return all failures regardless of inputted token. This method returns a `<Response 200>` if no Trace Check failures are being returned and a `<Response 400>` if Trace Check failures are being returned. Trace Check failures are returned as a content type of text, with failure messages concatenated in the response body. Optionally, set the `use_json` query string parameter to `true` to return Trace Check failures as a JSON response in the following format:
@@ -434,9 +434,9 @@ curl -X GET 'http://0.0.0.0:8126/test/trace_check/clear'
434
434
```
435
435
436
436
### /test/trace_check/summary (GET)
437
-
Get Trace Check summary results. If a token is included, returns summary results only for Trace Checks run during the session. The `return_all` optional query string parameter can be used to return all trace check results (regardless of inputted session token). The method returns Trace Check results in the following JSON format:
437
+
Get Trace Check summary results. If a token is included, returns summary results only for Trace Checks run during the session. The `return_all` optional query string parameter can be used to return all trace check results (regardless of inputted session token). The method returns Trace Check results in the following JSON format:
438
438
```
439
-
summary = {
439
+
summary = {
440
440
"trace_content_length" : {
441
441
"Passed_Checks": 10,
442
442
"Failed_Checks": 0,
@@ -465,7 +465,7 @@ curl -X PUT 'http://0.0.0.0:8126/test/session/integrations' -d '{"integration_na
465
465
```
466
466
467
467
### /test/integrations/tested_versions (GET)
468
-
Return a csv list of all tested integrations received by the agent. The format of returned data will be:
468
+
Return a csv list of all tested integrations received by the agent. The format of returned data will be:
0 commit comments