Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package co.elastic.apm.agent.tracer.configuration;
import co.elastic.apm.agent.premain.common.util.WildcardMatcher;
import org.stagemonitor.configuration.ConfigurationOption;
import org.stagemonitor.configuration.ConfigurationOptionProvider;
import org.stagemonitor.configuration.converter.ListValueConverter;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import static co.elastic.apm.agent.tracer.configuration.RangeValidator.isInRange;
public class WebConfiguration extends ConfigurationOptionProvider {
public static final int MAX_BODY_CAPTURE_BYTES = 1024;
private static final String HTTP_CATEGORY = "HTTP";
private final ConfigurationOption> captureContentTypes = ConfigurationOption
.builder(new ListValueConverter<>(new WildcardMatcherValueConverter()), List.class)
.key("capture_body_content_types")
.configurationCategory(HTTP_CATEGORY)
.tags("added[1.5.0]", "performance")
.description("Configures which content types should be recorded.\n" +
"\n" +
"The defaults end with a wildcard so that content types like `text/plain; charset=utf-8` are captured as well.\n" +
"\n" +
WildcardMatcher.DOCUMENTATION)
.dynamic(true)
.buildWithDefault(Arrays.asList(
WildcardMatcher.valueOf("application/x-www-form-urlencoded*"),
WildcardMatcher.valueOf("text/*"),
WildcardMatcher.valueOf("application/json*"),
WildcardMatcher.valueOf("application/xml*")
));
private final ConfigurationOption> ignoreUrls = ConfigurationOption
.builder(new ListValueConverter<>(new WildcardMatcherValueConverter()), List.class)
.key("transaction_ignore_urls")
.aliasKeys("ignore_urls")
.configurationCategory(HTTP_CATEGORY)
.description("Used to restrict requests to certain URLs from being instrumented.\n" +
"\n" +
"This property should be set to an array containing one or more strings.\n" +
"When an incoming HTTP request is detected, its URL will be tested against each element in this list.\n" +
"\n" +
WildcardMatcher.DOCUMENTATION)
.dynamic(true)
.buildWithDefault(Arrays.asList(
WildcardMatcher.valueOf("/VAADIN/*"),
WildcardMatcher.valueOf("/heartbeat*"),
WildcardMatcher.valueOf("/favicon.ico"),
WildcardMatcher.valueOf("*.js"),
WildcardMatcher.valueOf("*.css"),
WildcardMatcher.valueOf("*.jpg"),
WildcardMatcher.valueOf("*.jpeg"),
WildcardMatcher.valueOf("*.png"),
WildcardMatcher.valueOf("*.gif"),
WildcardMatcher.valueOf("*.webp"),
WildcardMatcher.valueOf("*.svg"),
WildcardMatcher.valueOf("*.woff"),
WildcardMatcher.valueOf("*.woff2")
));
private final ConfigurationOption> ignoreUserAgents = ConfigurationOption
.builder(new ListValueConverter<>(new WildcardMatcherValueConverter()), List.class)
.key("transaction_ignore_user_agents")
.aliasKeys("ignore_user_agents")
.tags("added[1.22.0]")
.configurationCategory(HTTP_CATEGORY)
.description("Used to restrict requests from certain User-Agents from being instrumented.\n" +
"\n" +
"When an incoming HTTP request is detected,\n" +
"the User-Agent from the request headers will be tested against each element in this list.\n" +
"Example: `curl/*`, `*pingdom*`\n" +
"\n" +
WildcardMatcher.DOCUMENTATION)
.dynamic(true)
.buildWithDefault(Collections.emptyList());
private final ConfigurationOption usePathAsName = ConfigurationOption.booleanOption()
.key("use_path_as_transaction_name")
.configurationCategory(HTTP_CATEGORY)
.tags("added[1.0.0,Changing this value at runtime is possible since version 1.22.0]")
.description("If set to `true`,\n" +
"transaction names of unsupported or partially-supported frameworks will be in the form of `$method $path` instead of just `$method unknown route`.\n" +
"\n" +
"WARNING: If your URLs contain path parameters like `/user/$userId`,\n" +
"you should be very careful when enabling this flag,\n" +
"as it can lead to an explosion of transaction groups.\n" +
"Take a look at the <> option on how to mitigate this problem by grouping URLs together.")
.dynamic(true)
.buildWithDefault(false);
private final ConfigurationOption> urlGroups = ConfigurationOption
.builder(new ListValueConverter<>(new WildcardMatcherValueConverter()), List.class)
.key("url_groups")
.tags("deprecated")
.configurationCategory(HTTP_CATEGORY)
.description("Deprecated in favor of <>.\n" +
"\n" +
"This option is only considered, when `use_path_as_transaction_name` is active.\n" +
"\n" +
"With this option, you can group several URL paths together by using a wildcard expression like `/user/*`.\n" +
"\n" +
WildcardMatcher.DOCUMENTATION)
.dynamic(true)
.buildWithDefault(Collections.emptyList());
private final ConfigurationOption captureClientRequestBytes = ConfigurationOption.integerOption()
.addValidator(isInRange(0, MAX_BODY_CAPTURE_BYTES))
.key("capture_http_client_request_body_size")
.configurationCategory(HTTP_CATEGORY)
.tags("added[1.50.0]", "internal")
.description("Configures how many bytes of http-client request bodies shall be captured. " +
"Note that only request bodies will be captured for content types matching the capture_body_content_types configuration. " +
" The maximum allowed value is " + MAX_BODY_CAPTURE_BYTES + " , a value of 0 disables body capturing")
.dynamic(true)
.buildWithDefault(0);
public List getIgnoreUrls() {
return ignoreUrls.get();
}
public List getIgnoreUserAgents() {
return ignoreUserAgents.get();
}
public boolean isUsePathAsName() {
return usePathAsName.get();
}
public List getUrlGroups() {
return urlGroups.get();
}
public List getCaptureContentTypes() {
return captureContentTypes.get();
}
public int getCaptureClientRequestBytes() {
return captureClientRequestBytes.get();
}
}
