Document DD_TRACE_ECHO_IGNORED_ROUTES

Open Beginner friendly
#39,746 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
go
Domain
documentation

Research direction

Start by locating the Echo v4 tracing documentation and the existing environment-variable reference in this documentation repository; use DataDog/dd-trace-go#5139 to verify the behavior described in the issue. Document the variable syntax, route-pattern matching, malformed-entry handling, and middleware/AppSec effect, with the examples from the issue, then confirm the page builds successfully.

Written by the indexing model from the issue text.

Description

What needs documenting

DataDog/dd-trace-go#5139 adds a new Echo v4 tracer environment variable: DD_TRACE_ECHO_IGNORED_ROUTES.

Suggested docs details

The variable accepts comma-separated entries in the form METHOD /pattern, for example:

DD_TRACE_ECHO_IGNORED_ROUTES=GET /ready,POST /health

The middleware matches each entry against the request method and the route pattern registered by Echo. It does not match the request URL, so parameterized routes should use the registered pattern, for example GET /users/:id rather than GET /users/123.

Malformed entries are ignored and logged. Ignored routes skip the Echo middleware span and also skip AppSec monitoring performed by that middleware, matching the existing WithIgnoreRequest behavior.

Related PR

DataDog/dd-trace-go#5139

Dominant language
JavaScript
Stars
618
Forks
1.3k
Avg merge
2d 5h
Merged PRs (30d)
471

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from DataDog/documentation

All issues in DataDog/documentation

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.