### YamlMime:JavaType
uid: "com.azure.core.util.TracingOptions"
fullName: "com.azure.core.util.TracingOptions"
name: "TracingOptions"
nameWithType: "TracingOptions"
summary: "Tracing configuration options for clients."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **TracingOptions**"
constructors:
- uid: "com.azure.core.util.TracingOptions.TracingOptions()"
  fullName: "com.azure.core.util.TracingOptions.TracingOptions()"
  name: "TracingOptions()"
  nameWithType: "TracingOptions.TracingOptions()"
  summary: "Creates new instance of <xref uid=\"com.azure.core.util.TracingOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TracingOptions\"></xref>"
  syntax: "public TracingOptions()"
  desc: "Creates new instance of <xref uid=\"com.azure.core.util.TracingOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TracingOptions\"></xref>"
- uid: "com.azure.core.util.TracingOptions.TracingOptions(java.lang.Class<? extends com.azure.core.util.tracing.TracerProvider>)"
  fullName: "com.azure.core.util.TracingOptions.TracingOptions(Class<? extends TracerProvider> tracerProvider)"
  name: "TracingOptions(Class<? extends TracerProvider> tracerProvider)"
  nameWithType: "TracingOptions.TracingOptions(Class<? extends TracerProvider> tracerProvider)"
  summary: "Creates new instance of <xref uid=\"com.azure.core.util.TracingOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TracingOptions\"></xref>"
  modifiers:
  - "protected"
  parameters:
  - description: "The type of the <xref uid=\"? extends com.azure.core.util.tracing.TracerProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TracerProvider\"></xref> implementation that should be used to construct an instance of\n <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Tracer\"></xref>.\n\n If the value is not set (or <code>null</code>), then the first <xref uid=\"? extends com.azure.core.util.tracing.TracerProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TracerProvider\"></xref> resolved by <a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html\">ServiceLoader</a> will\n be used to create an instance of <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Tracer\"></xref>. If the value is set and doesn't match any\n <xref uid=\"? extends com.azure.core.util.tracing.TracerProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TracerProvider\"></xref> resolved by <a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html\">ServiceLoader</a> an <xref uid=\"java.lang.IllegalStateException\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IllegalStateException\"></xref> will be thrown when\n  attempting to create an instance of <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Tracer\"></xref>."
    name: "tracerProvider"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html\">Class</a>&lt;<xref href=\"? extends com.azure.core.util.tracing.TracerProvider?alt=? extends com.azure.core.util.tracing.TracerProvider&text=TracerProvider\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "protected TracingOptions(Class<? extends TracerProvider> tracerProvider)"
  desc: "Creates new instance of <xref uid=\"com.azure.core.util.TracingOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TracingOptions\"></xref>"
methods:
- uid: "com.azure.core.util.TracingOptions.fromConfiguration(com.azure.core.util.Configuration)"
  fullName: "com.azure.core.util.TracingOptions.fromConfiguration(Configuration configuration)"
  name: "fromConfiguration(Configuration configuration)"
  nameWithType: "TracingOptions.fromConfiguration(Configuration configuration)"
  summary: "Loads tracing options from the configuration."
  modifiers:
  - "static"
  parameters:
  - description: "The <xref uid=\"com.azure.core.util.Configuration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration\"></xref> instance containing tracing options. If\n <code>null</code> is passed then <xref uid=\"com.azure.core.util.Configuration.getGlobalConfiguration()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration#getGlobalConfiguration()\"></xref> will be used."
    name: "configuration"
    type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static TracingOptions fromConfiguration(Configuration configuration)"
  desc: "Loads tracing options from the configuration."
  returns:
    description: "A <xref uid=\"com.azure.core.util.TracingOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TracingOptions\"></xref> reflecting updated tracing options loaded from the configuration,\n if no tracing options are found, default (enabled) tracing options will be returned."
    type: "<xref href=\"com.azure.core.util.TracingOptions?alt=com.azure.core.util.TracingOptions&text=TracingOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.util.TracingOptions.getAllowedTracingQueryParamNames()"
  fullName: "com.azure.core.util.TracingOptions.getAllowedTracingQueryParamNames()"
  name: "getAllowedTracingQueryParamNames()"
  nameWithType: "TracingOptions.getAllowedTracingQueryParamNames()"
  summary: "Gets the set of query parameter names that are allowed to be recorded in the URL."
  syntax: "public Set<String> getAllowedTracingQueryParamNames()"
  desc: "Gets the set of query parameter names that are allowed to be recorded in the URL."
  returns:
    description: "The set of query parameter names that are allowed to be recorded in the URL."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.core.util.TracingOptions.getTracerProvider()"
  fullName: "com.azure.core.util.TracingOptions.getTracerProvider()"
  name: "getTracerProvider()"
  nameWithType: "TracingOptions.getTracerProvider()"
  summary: "Gets name of the <xref uid=\"? extends com.azure.core.util.tracing.TracerProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TracerProvider\"></xref> implementation that should be used to construct an instance of <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Tracer\"></xref>."
  syntax: "public Class<? extends TracerProvider> getTracerProvider()"
  desc: "Gets name of the <xref uid=\"? extends com.azure.core.util.tracing.TracerProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TracerProvider\"></xref> implementation that should be used to construct an instance of <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Tracer\"></xref>."
  returns:
    description: "The <xref uid=\"? extends com.azure.core.util.tracing.TracerProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TracerProvider\"></xref> implementation used to create an instance of <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Tracer\"></xref>."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html\">Class</a>&lt;<xref href=\"? extends com.azure.core.util.tracing.TracerProvider?alt=? extends com.azure.core.util.tracing.TracerProvider&text=TracerProvider\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.core.util.TracingOptions.isEnabled()"
  fullName: "com.azure.core.util.TracingOptions.isEnabled()"
  name: "isEnabled()"
  nameWithType: "TracingOptions.isEnabled()"
  summary: "Flag indicating if distributed tracing should be enabled."
  syntax: "public boolean isEnabled()"
  desc: "Flag indicating if distributed tracing should be enabled."
  returns:
    description: "<code>true</code> if tracing is enabled, <code>false</code> otherwise."
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.util.TracingOptions.setAllowedTracingQueryParamNames(java.util.Set<java.lang.String>)"
  fullName: "com.azure.core.util.TracingOptions.setAllowedTracingQueryParamNames(Set<String> allowedQueryParamNames)"
  name: "setAllowedTracingQueryParamNames(Set<String> allowedQueryParamNames)"
  nameWithType: "TracingOptions.setAllowedTracingQueryParamNames(Set<String> allowedQueryParamNames)"
  summary: "Sets the set of query parameter names that are allowed to be recorded in the URL."
  parameters:
  - description: "The set of query parameter names that are allowed to be recorded in the URL."
    name: "allowedQueryParamNames"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
  syntax: "public TracingOptions setAllowedTracingQueryParamNames(Set<String> allowedQueryParamNames)"
  desc: "Sets the set of query parameter names that are allowed to be recorded in the URL."
  returns:
    description: "The updated <xref uid=\"com.azure.core.util.TracingOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TracingOptions\"></xref> object."
    type: "<xref href=\"com.azure.core.util.TracingOptions?alt=com.azure.core.util.TracingOptions&text=TracingOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.util.TracingOptions.setEnabled(boolean)"
  fullName: "com.azure.core.util.TracingOptions.setEnabled(boolean enabled)"
  name: "setEnabled(boolean enabled)"
  nameWithType: "TracingOptions.setEnabled(boolean enabled)"
  summary: "Enables or disables distributed tracing."
  parameters:
  - description: "pass <code>true</code> to enable tracing."
    name: "enabled"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public TracingOptions setEnabled(boolean enabled)"
  desc: "Enables or disables distributed tracing. By default, tracing is enabled if and only if tracing implementation is detected."
  returns:
    description: "the updated <code>TracingOptions</code> object."
    type: "<xref href=\"com.azure.core.util.TracingOptions?alt=com.azure.core.util.TracingOptions&text=TracingOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Tracing configuration options for clients."
metadata: {}
package: "com.azure.core.util"
artifact: com.azure:azure-core:1.54.0