Skip to content
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

WIP: Include context path into skip pattern #120

Closed
wants to merge 2 commits into from
Closed

WIP: Include context path into skip pattern #120

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
848cb16
Include context path into skip pattern
pavolloffay Nov 1, 2018
111674f
Fix review comments
pavolloffay Nov 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions spec/src/main/asciidoc/microprofile-opentracing.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,13 +184,13 @@ If there is an exception object available the implementation SHOULD also add log
[[server-skip-pattern]]
===== Disabling server side tracing
Server side tracing can be disabled by specifying a skip pattern which is used to match with HTTP path
`UriInfo.getPath()`. If the regex matches with HTTP path then tracing for the given server
request is disabled even if the method or class is annotated with `@Traced`.
The configuration does not disable any outbound request made from the disabled
server endpoint.
including context path and excluding query parameters e.g. `UriInfo.getAbsolutePath().getPath()`.
If the regex matches with HTTP path then tracing for the given server request is disabled even if
the method or class is annotated with `@Traced`. The configuration does not disable any outbound
request made from the disabled server endpoint.

The skip pattern is specified as a string with key `mp.opentracing.server.skip-pattern` which has to be
compliant with `java.util.regex.Pattern`. An example skip pattern might be `mp.opentracing.server.skip-pattern=/health|/metrics.*`
compliant with `java.util.regex.Pattern`. An example skip pattern might be `mp.opentracing.server.skip-pattern/context/=/health|/metrics.*`
pavolloffay marked this conversation as resolved.
Show resolved Hide resolved

The default value of the skip pattern excludes tracing for default endpoints defined by MicroProfile Health, Metrics and OpenAPI specification.

Expand Down
6 changes: 3 additions & 3 deletions tck/running_the_tck.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
// limitations under the License.
//

= Running the Microprofile OpenTracing TCK
= Running the MicroProfile-OpenTracing TCK

Any Microprofile 1.1 and higher release must pass this test suite.
The TCK uses `testng`
Any implementation must pass this test suite.
The tests expects the test app to be deployed on `/opentracing` root context path.

== Dependencies

Expand Down
2 changes: 1 addition & 1 deletion tck/src/main/java/org/eclipse/microprofile/opentracing/tck/OpenTracingSkipPatternTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public static class TestConfiguration implements ConfigSource {
private Map<String, String> propMap = new HashMap<>();

{
propMap.put("mp.opentracing.server.skip-pattern", "/skipAll/.*|/testServices/skipSimple");
propMap.put("mp.opentracing.server.skip-pattern", "/opentracing/rest/skipAll/.*|/opentracing/rest/testServices/skipSimple");
}

@Override
Expand Down