META-INF.instrumentation.servlet.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of instrumentation-servlet Show documentation
Show all versions of instrumentation-servlet Show documentation
Instrumentation for the Servlet API
{
"name": "Servlet",
"id": "servlet",
"properties": [
{
"name": "sessionUserAttribute",
"type": "string",
"label": "Session user attribute",
"description": "Session attribute to capture as the user of the trace. Traces can be filtered by user in the explorer. Nested paths are supported, e.g. something.user.username. The attribute value is converted into a String if necessary via toString(). The special attribute name '::id' can be used to refer to the http session id."
},
{
"name": "captureSessionAttributes",
"type": "list",
"label": "Session attributes",
"description": "List of servlet session attributes to capture in the root trace entry. Nested paths are supported, e.g. mainObject.nestedObject.displayName. '*' at the end of a path is supported, e.g. mainObject.nestedObject.*, meaning capture all properties of mainObject.nestedObject (via reflection, looking at methods that begin with \"get[A-Z]\" or \"is[A-Z]\"). '*' by itself means capture all session attributes. Values are converted into Strings if necessary via toString(). The special attribute name '::id' can be used to refer to the http session id."
},
{
"name": "captureRequestParameters",
"type": "list",
"default": [
"*"
],
"label": "Capture request parameters",
"description": "List of request parameters to capture in the root trace entry. The wildcard '*' is supported anywhere in the parameter name."
},
{
"name": "maskRequestParameters",
"type": "list",
"default": [
"*password*"
],
"label": "Mask request parameters",
"description": "List of sensitive request parameters to mask, e.g. passwords. The wildcard '*' is supported anywhere in the parameter name."
},
{
"name": "captureRequestHeaders",
"type": "list",
"default": [
"User-Agent"
],
"label": "Capture request headers",
"description": "List of request headers to capture in the root trace entry. The wildcard '*' is supported anywhere in the header name."
},
{
"name": "captureRequestCookies",
"type": "list",
"label": "Capture request parameters",
"description": "List of request cookies to capture in the root trace entry. The wildcard '*' is supported anywhere in the cookie name."
},
{
"name": "captureResponseHeaders",
"type": "list",
"label": "Capture response headers",
"description": "List of response headers to capture in the root trace entry. The wildcard '*' is supported anywhere in the header name."
},
{
"name": "traceErrorOn4xxResponseCode",
"type": "boolean",
"label": "Error on 4xx",
"checkboxLabel": "Mark trace as error on 4xx response code",
"description": "Mark the trace as an error when a 4xx response code is returned."
},
{
"name": "captureRequestRemoteAddr",
"type": "boolean",
"label": "Capture request remote address",
"checkboxLabel": "Capture request remote address using ServletRequest.getRemoteAddr()"
},
{
"name": "captureRequestRemoteHostname",
"type": "boolean",
"label": "Capture request remote hostname",
"checkboxLabel": "Capture request remote hostname using ServletRequest.getRemoteHost()"
},
{
"name": "captureRequestRemotePort",
"type": "boolean",
"label": "Capture request remote port",
"checkboxLabel": "Capture request remote port using ServletRequest.getRemotePort()",
"description": "This only applies to Servlet 3.0+ containers."
},
{
"name": "captureRequestLocalAddr",
"type": "boolean",
"label": "Capture request local address",
"checkboxLabel": "Capture request local address using ServletRequest.getLocalAddr()",
"description": "This only applies to Servlet 3.0+ containers."
},
{
"name": "captureRequestLocalHostname",
"type": "boolean",
"label": "Capture request local hostname",
"checkboxLabel": "Capture request local hostname using ServletRequest.getLocalName()",
"description": "This only applies to Servlet 3.0+ containers."
},
{
"name": "captureRequestLocalPort",
"type": "boolean",
"label": "Capture request local port",
"checkboxLabel": "Capture request local port using ServletRequest.getLocalPort()",
"description": "This only applies to Servlet 3.0+ containers."
},
{
"name": "captureRequestServerHostname",
"type": "boolean",
"label": "Capture request server hostname",
"checkboxLabel": "Capture request server hostname using ServletRequest.getServerName()"
},
{
"name": "captureRequestServerPort",
"type": "boolean",
"label": "Capture request server port",
"checkboxLabel": "Capture request server port using ServletRequest.getServerPort()"
},
{
"name": "captureRequestScheme",
"type": "boolean",
"label": "Capture request scheme",
"checkboxLabel": "Capture request scheme using ServletRequest.getScheme()"
}
],
"advice": [
{
"className": "javax.servlet.ServletContextListener",
"methodName": "contextInitialized",
"methodParameterTypes": [
"javax.servlet.ServletContextEvent"
],
"captureKind": "transaction",
"transactionType": "Startup",
"transactionNameTemplate": "Listener init: {{this.class.name}}",
"alreadyInTransactionBehavior": "capture-local-span",
"timerName": "listener init"
},
{
"className": "javax.servlet.Servlet",
"methodName": "init",
"methodParameterTypes": [
"javax.servlet.ServletConfig"
],
"captureKind": "transaction",
"transactionType": "Startup",
"transactionNameTemplate": "Servlet init: {{this.class.name}}",
"alreadyInTransactionBehavior": "capture-local-span",
"timerName": "servlet init"
},
{
"className": "javax.servlet.Filter",
"methodName": "init",
"methodParameterTypes": [
"javax.servlet.FilterConfig"
],
"captureKind": "transaction",
"transactionType": "Startup",
"transactionNameTemplate": "Filter init: {{this.class.name}}",
"alreadyInTransactionBehavior": "capture-local-span",
"timerName": "filter init"
},
{
"className": "javax.servlet.ServletContainerInitializer",
"methodName": "onStartup",
"methodParameterTypes": [
"java.util.Set",
"javax.servlet.ServletContext"
],
"captureKind": "transaction",
"transactionType": "Startup",
"transactionNameTemplate": "Container initializer: {{this.class.name}}",
"alreadyInTransactionBehavior": "capture-local-span",
"timerName": "container initializer"
},
{
"className": "org.wildfly.extension.undertow.deployment.UndertowDeploymentService",
"methodName": "startContext",
"methodParameterTypes": [
],
"captureKind": "transaction",
"transactionType": "Startup",
"transactionNameTemplate": "Servlet context: {{this.deploymentInfoInjectedValue.value.contextPath}}",
"alreadyInTransactionBehavior": "capture-local-span",
"timerName": "application startup"
},
{
"className": "org.eclipse.jetty.webapp.WebAppContext",
"methodName": "doStart",
"methodParameterTypes": [
],
"captureKind": "transaction",
"transactionType": "Startup",
"transactionNameTemplate": "Servlet context: {{this.contextPath}}",
"alreadyInTransactionBehavior": "capture-local-span",
"timerName": "application startup"
}
],
"classes": [
"org.glowroot.instrumentation.servlet.ServletInstrumentation",
"org.glowroot.instrumentation.servlet.AsyncServletInstrumentation",
"org.glowroot.instrumentation.servlet.RequestInstrumentation",
"org.glowroot.instrumentation.servlet.ResponseInstrumentation",
"org.glowroot.instrumentation.servlet.RequestDispatcherInstrumentation",
"org.glowroot.instrumentation.servlet.SessionInstrumentation",
"org.glowroot.instrumentation.servlet.CatalinaAppStartupInstrumentation",
"org.glowroot.instrumentation.servlet.WebLogicAppStartupInstrumentation",
"org.glowroot.instrumentation.servlet.WebSphereAppStartupInstrumentation"
],
"collocate": true
}