vuApp360 Deployment & Configuration

vuSmartMaps Configuration: Enabling Distributed Traces Telemetry

Traces O11ySource collects Distributed Traces telemetry from applications to provide comprehensive observability, offering deep insights into application performance through standard applications performance monitoring dashboards.

Enabling Traces O11ySource

1. Navigate to O11ySources:
   1. vuSmartMaps O11ySources can be accessed by navigating from the left navigation menu (Data Ingestion > O11ySources).
2. Locate Traces O11ySource on the landing page.

3. Enable Traces O11ySources:
   1. Click the Enable button to activate Traces O11ySource.

Configuring Data Sources

1. Navigate to the Sources tab and click the + button to add new services to be monitored.
2. Fill up the Following Details in the Wizard:
   1. Applications Group: Name of the application group.
   2. SSL Required: If Yes, TLS will be turned ON.
   3. Application Services: Specify the name of your application and service that will be displayed in the observability UI. In a microservices architecture, an application can consist of multiple services. However, in the absence of microservices, each application would typically have just one service. It is possible to have the same name for both the application and service if desired.
      1. Language: The programming language used for developing the application service: Java, NodeJS, .NET, GoLang.
      2. Application Name: Name of the target application.
      3. Service Name: Service name in the application. Typically in monolithic applications, the service name and application name are the same. In the microservices application, there would be one application that can have one or more services.
   4. Export HTTP Header (True/False): Enable this field, if HTTP Header is required to be captured.

3. Download the client instrumentation package for the selected language from the agent configuration wizard.

4. Follow the instructions provided in the client instrumentation package.

Following these steps, you have successfully enabled Traces O11ySource and configured the data sources for real-time application performance monitoring.

Configuring Sampling Policies

Sampling configuration allows the system to selectively decide on which traces to store. This helps in reducing the amount of data kept in the system.

There are two types of sampling policies that can be configured for traces:

• Global Policies: Apply to all types of traces coming into the system.
• Service-Specific Policies: Apply to a specific set of services.

A separate page for sampling-related configurations is introduced. These configurations are controlled from the Settings tab on the Traces O11ySource page. The Settings tab includes three sections:

1. Sampling Policy
   Defines policies for deciding which traces to store. Policies can use inline rules or refer to rules defined in the Sampling Rules section.
2. Sampling Rule
   Provides a way to define individual rules that can be referred to in Sampling Policies to form compound rules.
3. Additional Configuration
   Controls data enrichments and transformations on received traces using optional YAML configurations.

note

The dashboards provided in vuApp360 are designed to display pre-sampled data.

Sampling Policy

Sampling Policies configured here allow vuSmartMaps to intelligently decide on which traces to store, helping to reduce the amount of data kept in the system by selecting only important traces. This is an optional functionality. If no sampling policies are configured, vuSmartMaps will store 100% of the traces collected.

Sampling policies can use rules defined inline within them or refer to rules defined in the Sampling Rules section. Using rules from sampling rules in policies enables users to define compound policies that can refer to more than one rule. When multiple sampling policies are configured, vuSmartMaps will apply all the policies to all traces received and will take a final decision based on the following:

• The trace is dropped when there is one explicit 'Do not sample' decision based on an inverted match.
• The trace is stored when there is one 'Sample' decision.
• The trace is stored when there is one 'Sample' decision based on an inverted match and there are no 'Do not sample' decisions.
• The trace is dropped in all other cases.

To configure a new sampling policy, use the + button and provide the following details in the modal:

• Policy Name: Unique name assigned by the user.
• Scope: Specify whether the policy applies to all traces (Global) or to a specific set of services. Options include All, For These Services, For Services Except These.
• Definition Type: Choose to define the policy details inline or refer to a rule defined in the Sampling Rules Section.
  • Inline: If this option is selected, the configured policy type becomes applicable:
• Policy Type: Specify the type of sampling policy. vuSmartMaps offers following seven policy types:
  1. Allow All: Marks all traces received to be stored.
  2. Data Rate: Tracks spans per second rate of traces and drops traces beyond the configured threshold.
     1. Spans per Second: Maximum number of spans that can be processed each second.
  3. Latency: Stores only those traces with latency greater than the configured threshold.
     1. Threshold in Milliseconds: Only traces with latency greater than the given threshold (in ms) will be allowed.
  4. Number Attribute: Stores only those traces with the value of the configured attribute falling within a specified range.
     1. Attribute: Select the attribute key to match data received from applications (e.g., HTTP Status Code).
     2. Minimum Value: Enter the minimum acceptable value (e.g., 400 for HTTP Status codes).
     3. Maximum Value: Enter the maximum acceptable value (e.g., 500 for HTTP Status codes).
  5. Percentage: Stores only a specified percentage of traces received, dropping the rest.
     1. Sampling Percentage: The percentage rate at which traces are sampled.
  6. Status: Stores traces with specified statuses, dropping the rest.
     1. Status Type: Status value for which traces will be retained. Options: Error, OK, Unset.
  7. String Attribute: Stores only those traces with the value of a configured attribute matching the configured condition.
     1. Attribute: Select the attribute key to match data received from applications (e.g., Application, Service Name, Host Name, HTTP Host, HTTP Target, HTTP Route, HTTP URL, DB Name, DB System, Messaging System, Transaction).
     2. Values: Enter the values to match against (e.g., health, metrics, etc.).
     3. Regular Expression: When 'True', the system will match the attribute values by regular expression string.
     4. Invert Match: When 'True', the system will reverse the match condition.
• Use Predefined Rule Sets: If this option is selected, choose one of the following policy types and select the relevant rules from the Sampling Rules section:
  1. AND of Multiple Rules: Build a compound rule with an AND of multiple rules defined in the Sampling Rules section.
  2. Rate Distribution: Allocate portions of the total allowed rate to a set of rules from the Sampling Rules Section. Traces matching each rule will be allocated a portion of the total rate allowed.
  3. Single Rule: Use a single rule defined in the Sampling Rules section.

Sampling Rule

Sampling rules provide a way to define individual rules that can be referred to in Sampling Policies to form compound rules. The rules defined in Sampling Rules are not used unless referred to by a policy in Sampling Policies. Using rules from Sampling Rules in policies enables users to define compound policies that can refer to more than one rule.

To configure a new sampling rule, use the + button and provide the following details in the modal:

• Rule Name: Unique name assigned by the user.
• Rule Type: Specify the type of sampling rule. vuSmartMaps offers seven predefined rule types (as explained above for inline policy types).

Additional Configuration

The Additional Configuration section can be used to control data enrichments and transformations done on traces received. Users can add optional YAML configurations. Below is an example:

transform:  
trace_statements:  
 - context: span  
   statements:  
     - set(attributes["instrumentation_library_name"], instrumentation_scope.name)  
     - set(attributes["library"], attributes["db.system"])  
     - set(attributes["library"], attributes["messaging.system"])  
     - set(attributes["library"], "Express") where instrumentation_scope.name == "@opentelemetry/instrumentation-express"  
     - set(attributes["library"], "MongoDB") where instrumentation_scope.name == "io.opentelemetry.mongo-3.1"  
     - set(attributes["library"], "Go-kit") where instrumentation_scope.name == "go.opentelemetry.io/contrib/instrumentation/github.com/go-kit/kit/otelkit"  
     - set(attributes["library"], "RabbitMQ") where instrumentation_scope.name == "io.opentelemetry.rabbitmq-2.7"  
     - set(attributes["library"], "NodeJS HTTP Client / Server") where instrumentation_scope.name == "@opentelemetry/instrumentation-http"  
     - set(attributes["library"], "Redis") where instrumentation_scope.name == "@opentelemetry/instrumentation-redis"  
     - set(attributes["library"], "Spring MVC") where instrumentation_scope.name == "io.opentelemetry.spring-webmvc-3.1"  
     - set(attributes["library"], "Tomcat") where instrumentation_scope.name == "io.opentelemetry.tomcat-7.0"  
     - set(attributes["library"], "Servlet") where instrumentation_scope.name == "io.opentelemetry.servlet-3.0"  
     - set(attributes["library"], attributes["db.system"]) where instrumentation_scope.name == "io.opentelemetry.jdbc"  
     - set(attributes["library"], "Spring Data") where instrumentation_scope.name == "io.opentelemetry.spring-data-1.8"  
     - set(attributes["library"], "Hibernate") where instrumentation_scope.name == "io.opentelemetry.hibernate-4.0"  
     - set(attributes["library"], "Go HTTP Client / Server") where instrumentation_scope.name == "go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"  
     - set(attributes["library"], "Spring Scheduling") where instrumentation_scope.name == "io.opentelemetry.spring-scheduling-3.1 1.14.0-alpha"  
     - set(attributes["destination"], attributes["db.system"])  
     - set(attributes["destination"], attributes["messaging.system"])  
     - set(attributes["destination"], attributes["net.peer.name"])  
     - set(attributes["destination"], replace_match(attributes["http.url"], "https?://[^/]+/([^/]+)", "$1"))  
     - set(attributes["transaction"], Concat([attributes["http.method"], attributes["http.target"]], " ")) where (attributes["http.target"] != nil and attributes["http.method"] != nil and attributes["http.target"] != "")  
     - set(attributes["transaction"], Concat([attributes["http.method"], attributes["http.route"]], " ")) where (attributes["http.route"] != nil and attributes["http.method"] != nil and attributes["http.route"] != "")  
     - set(attributes["site"], "default")

This configuration enriches and transforms trace data, making it more meaningful and useful for analysis.

The Settings tab for Traces O11ySource provides a centralized location for configuring sampling policies, rules, and additional configurations. This setup simplifies the process, reduces user confusion, and enhances the ability to manage and control the data stored in the system effectively. By intelligently sampling traces, users can ensure that they are storing only the most relevant and important data, optimizing both storage and analysis capabilities.

Client Side Traces Instrumentation

Java

Instrumentation Process

SpringBoot / jar

Steps to instrument the java application running as a SpringBoot / jar:

1. Download the client instrumentation package from the O11ysource, which contains the vunet-opentelemetry-javaagent.jar.

   1. Place the vunet-opentelemetry-javaagent.jar in your preferred directory.

2. Launch the application with the following configuration

   java -javaagent:path/to/vunet-opentelemetry-javaagent.jar
   -Dotel.resource.attributes=application=<APPLICATION_NAME>
   -Dotel.service.name=<SERVICE_NAME> -Dotel.metrics.exporter=none
   -Dotel.exporter.otlp.endpoint=<TRACES_INGESTION_ENDPOINT> -jar app.jar

3. Ensure to update the following before using this command.

   • APPLICATION_NAME: Change it to match your application name.
   • SERVICE_NAME: Change it to match the service name (microservices) or application layer (monolithic)
   • TRACES_INGESTION_ENDPOINT: Change it to match the URL of the vuSmartMaps.
     • This should be http://<vuSmartMaps Server IP>:4317.

Example:

• Here, the vuSmartMaps is running in the host with IP 10.0.0.1

  java -javaagent:vunet-opentelemetry-javaagent.jar
  -Dotel.resource.attributes=application=UPI -Dotel.service.name=upi-switch
  -Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=http://10.0.0.1:4317 -jar upi.jar

JBoss / WildFly (Standalone Mode) in Linux

Steps to instrument the java application running in JBoss / WildFly (Standalone Mode) in Linux:

1. Download the client instrumentation package, which contains the vunet-opentelemetry-javaagent.jar.

   • Place the vunet-opentelemetry-javaagent.jar in your preferred directory.

2. Edit the <JBOss_HOME>/bin/standalone.conf file and update the JAVA_OPTS environment variable

   JAVA_OPTS="-javaagent:path/to/vunet-opentelemetry-javaagent.jar -Dotel.resource.attributes=application=<APPLICATION_NAME> -Dotel.service.name=<SERVICE_NAME> -Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=<TRACES_INGESTION_ENDPOINT>"

3. Ensure to update the following before using this command.

   • APPLICATION_NAME: Change it to match your application name
   • SERVICE_NAME:
     • Change it to match the service name (microservices) or application layer (monolithic).
     • When multiple war files are running in a single JBoss / Wildfly server, then enable the auto discovery of service name using the argument

       -Dotel.service.name=FROM_WEB_CONTEXT

   • TRACES_INGESTION_ENDPOINT: Change it to match the URL of the vuSmartMaps. It should be http://<vuSmartMaps Server IP>:4317

   Example:

   JAVA_OPTS="$JAVA_OPTS -javaagent:D:\Dev\OTel\auto_instrumentation_package_java\otel-lib\vunet-opentelemetry-javaagent.jar -Dotel.resource.attributes=application=APPLICATION_NAME -Dotel.service.name=SERVICE_NAME -Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=http://localhost:4317"

4. Restart JBoss

JBoss / WildFly (Domain Mode) in Linux

Steps to instrument the java application running in JBoss / WildFly (Domain Mode) in Linux:

1. Download the client instrumentation package, which contains the vunet-opentelemetry-javaagent.jar.

   • Place the vunet-opentelemetry-javaagent.jar in your preferred directory.

2. Edit the <JBOss_HOME>/bin/domain.conf file and update the JAVA_OPTS environment variable

   JAVA_OPTS="-javaagent:path/to/vunet-opentelemetry-javaagent.jar -Dotel.resource.attributes=application=<APPLICATION_NAME> -Dotel.service.name=<SERVICE_NAME> -Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=<TRACES_INGESTION_ENDPOINT>"

3. Ensure to update the following before using this command.

   • APPLICATION_NAME: Change it to match your application name
   • SERVICE_NAME:
     • Change it to match the service name (microservices) or application layer (monolithic).
     • When multiple war files are running in a single JBoss / Wildfly server, then enable the auto discovery of service name using the argument

       -Dotel.service.name=FROM_WEB_CONTEXT

   • TRACES_INGESTION_ENDPOINT: Change it to match the URL of the vuSmartMaps. It should be http://<vuSmartMaps Server IP>:4317.

   Example:

   JAVA_OPTS="$JAVA_OPTS -javaagent:D:\Dev\OTel\auto_instrumentation_package_java\otel-lib\vunet-opentelemetry-javaagent.jar -Dotel.resource.attributes=application=APPLICATION_NAME -Dotel.service.name=SERVICE_NAME -Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=http://localhost:4317"

4. Restart JBoss

JBoss / WildFly (Standalone Mode) in Windows

Steps to instrument the java application running in JBoss / WildFly (Standalone Mode) in Windows:

1. Download the client instrumentation package, which contains the vunet-opentelemetry-javaagent.jar.

   • Place the vunet-opentelemetry-javaagent.jar in your preferred directory.

2. Edit the <JBOss_HOME>/bin/standalone.conf.bat file and update the JAVA_OPTS environment variable

   JAVA_OPTS="-javaagent:path/to/vunet-opentelemetry-javaagent.jar -Dotel.resource.attributes=application=<APPLICATION_NAME> -Dotel.service.name=<SERVICE_NAME> -Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=<TRACES_INGESTION_ENDPOINT>"

3. Ensure to update the following before using this command.

   • APPLICATION_NAME: Change it to match your application name
   • SERVICE_NAME:
     • Change it to match the service name (microservices) or application layer (monolithic).
     • When multiple war files are running in a single JBoss / Wildfly server, then enable the auto discovery of service name using the argument

       -Dotel.service.name=FROM_WEB_CONTEXT

   • TRACES_INGESTION_ENDPOINT: Change it to match the URL of the vuSmartMaps. It should be http://<vuSmartMaps Server IP>:4317.

   Example:

   set "JAVA_OPTS=%$JAVA_OPTS% -javaagent:D:\Dev\OTel\auto_instrumentation_package_java\otel-lib\vunet-opentelemetry-javaagent.jar -Dotel.resource.attributes=application=APPLICATION_NAME -Dotel.service.name=SERVICE_NAME -Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=http://localhost:4317"

4. Restart JBoss

JBoss / WildFly (Domain Mode) in Windows

Steps to instrument the java application running in JBoss / WildFly (Domain Mode) in Windows:

1. Download the client instrumentation package, which contains the vunet-opentelemetry-javaagent.jar.

   • Place the vunet-opentelemetry-javaagent.jar in your preferred directory.

2. Edit the <JBOss_HOME>/bin/domain.conf.bat file and update the JAVA_OPTS environment variable

   JAVA_OPTS="-javaagent:path/to/vunet-opentelemetry-javaagent.jar -Dotel.resource.attributes=application=<APPLICATION_NAME> -Dotel.service.name=<SERVICE_NAME> -Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=<TRACES_INGESTION_ENDPOINT>"

3. Ensure to update the following before using this command.

   • APPLICATION_NAME: Change it to match your application name
   • SERVICE_NAME:
     • Change it to match the service name (microservices) or application layer (monolithic).
     • When multiple war files are running in a single JBoss / Wildfly server, then enable the auto discovery of service name using the argument

       -Dotel.service.name=FROM_WEB_CONTEXT

   • TRACES_INGESTION_ENDPOINT: Change it to match the URL of the vuSmartMaps. It should be http://<vuSmartMaps Server IP>:4317.

   Example:

   set "JAVA_OPTS=%$JAVA_OPTS% -javaagent:D:\Dev\OTel\auto_instrumentation_package_java\otel-lib\vunet-opentelemetry-javaagent.jar -Dotel.resource.attributes=application=APPLICATION_NAME -Dotel.service.name=SERVICE_NAME -Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=http://localhost:4317"

4. Restart JBoss

Apache Tomcat running on Linux

Steps to instrument the java application running in Apache Tomcat running on Linux

1. Download the client instrumentation package, which contains the vunet-opentelemetry-javaagent.jar.

   • Place the vunet-opentelemetry-javaagent.jar in your preferred directory.

2. Edit the setenv.sh in the bin directory of Tomcat and add the following content.

   • Create the setenv.sh in the bin directory if it doesn't exist

     export CATALINA_OPTS="$CATALINA_OPTS -javaagent:path/to/vunet-opentelemetry-javaagent.jar"
     export OTEL_EXPORTER_OTLP_ENDPOINT=<TRACES_INGESTION_ENDPOINT>
     export OTEL_RESOURCE_ATTRIBUTES=application=<APPLICATION_NAME> 
     export OTE_SERVICE_NAME=<SERVICE_NAME>
     export OTEL_METRICS_EXPORTER=none

3. Ensure to update the following before using this command.

   • APPLICATION_NAME: Change it to match your application name
   • SERVICE_NAME:
     • Change it to match the service name (microservices) or application layer (monolithic).
     • When multiple war files are running in a single Apache Tomcat server, then enable the auto discovery of service name using the argument

       -Dotel.service.name=FROM_WEB_CONTEXT

   • TRACES_INGESTION_ENDPOINT: Change it to match the URL of the vuSmartMaps. It should be http://<vuSmartMaps Server IP>:4317

4. Restart Apache Tomcat

Apache Tomcat running on Windows

Steps to instrument the java application running in Apache Tomcat running on Windows:

1. Download the client instrumentation package, which contains the vunet-opentelemetry-javaagent.jar.

   • Place the vunet-opentelemetry-javaagent.jar in your preferred directory.

2. Edit the setenv.bat in the bin directory of Tomcat and add the following content.

   • Create the setenv.bat in the bin directory if it doesn't exist

     set "CATALINA_OPTS=%CATALINA_OPTS% -javaagent:path\to\vunet-opentelemetry-javaagent.jar" 
     set "OTEL_EXPORTER_OTLP_ENDPOINT=<TRACES_INGESTION_ENDPOINT>" 
     set "OTEL_RESOURCE_ATTRIBUTES=application=<APPLICATION_NAME> -Dotel.service.name=<SERVICE_NAME>" 
     set "OTEL_METRICS_EXPORTER=none"

3. Ensure to update the following before using this command.

   • APPLICATION_NAME: Change it to match your application name
   • SERVICE_NAME:
     • Change it to match the service name (microservices) or application layer (monolithic).
     • When multiple war files are running in a single Apache Tomcat server, then enable the auto discovery of service name using the argument

       -Dotel.service.name=FROM_WEB_CONTEXT

   • TRACES_INGESTION_ENDPOINT: Change it to match the URL of the vuSmartMaps. It should be http://<vuSmartMaps Server IP>:4317

4. Restart Apache Tomcat

Weblogic (Standalone Weblogic Servers)

Steps to instrument the java application running in a standalone Weblogic server:

1. Download the client instrumentation package, which contains the vunet-opentelemetry-javaagent.jar.

   • Place the vunet-opentelemetry-javaagent.jar in your preferred directory.

2. Edit startWebLogic.sh located at <weblogic_<version#>_install_dir>/user_projects/domains/<domain_name>/bin/startWebLogic.sh.

   • Add the following to the beginning of your application server start script

     export   JAVA_OPTIONS="$JAVA_OPTIONS -javaagent:path/to/vunet-opentelemetry-javaagent.jar -Dotel.resource.attributes=application=<APPLICATION_NAME> -Dotel.service.name=<SERVICE_NAME> -Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=<TRACES_INGESTION_ENDPOINT>"

3. Ensure to update the following before using this command.

   • APPLICATION_NAME: Change it to match your application name
   • SERVICE_NAME:
     • Change it to match the service name (microservices) or application layer (monolithic).
     • When multiple war files are running in a single Weblogic server, then enable the auto discovery of service name using the argument

       -Dotel.service.name=FROM_WEB_CONTEXT

   • TRACES_INGESTION_ENDPOINT: Change it to match the URL of the vuSmartMaps. It should be http://<vuSmartMaps Server IP>:4317

4. Restart Weblogic

Weblogic (Servers managed by Admin Console)

Steps to instrument the java application running in clustered Weblogic server where the admin console is used to manage the instance:

1. Download the client instrumentation package, which contains the vunet-opentelemetry-javaagent.jar.

   • Place the vunet-opentelemetry-javaagent.jar in your preferred directory.

2. For clustered WebLogic servers, you start and stop using Node Manager and configure server startup in the WebLogic Server Administration Console.

3. Open the WebLogic Server Administration Console.

4. Navigate to Environment > Servers and click your server in the Server List

5. Click the Server Start tab.

6. Add the javaagent argument and set the value to the path to the Java Agent

   -javaagent:path/to/vunet-opentelemetry-javaagent.jar -Dotel.resource.attributes=application=<APPLICATION_NAME> -Dotel.service.name=<SERVICE_NAME> -Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=<TRACES_INGESTION_ENDPOINT> -Dotel.exporter.otlp.compression=gzip

7. Please update the following before using this command.

   • APPLICATION_NAME: Change it to match your application name
   • SERVICE_NAME:
     • Change it to match the service name (microservices) or application layer (monolithic).
     • When multiple war files are running in a single Weblogic server, then enable the auto discovery of service name using the argument

       -Dotel.service.name=FROM_WEB_CONTEXT

   • TRACES_INGESTION_ENDPOINT: Change it to match the URL of the vuSmartMaps. It should be http://<vuSmartMaps Server IP>:4317

8. Restart the Weblogic managed server

Websphere Application Server ND

Steps to instrument the java application running in Websphere Application Server Network Deployment:

1. Download the client instrumentation package which contains the vunet-opentelemetry-javaagent.jar.

   • Place the vunet-opentelemetry-javaagent.jar in your preferred directory.

2. Log in to the WebSphere Integrated Solutions Console

3. Navigate to Servers > Server type > WebSphere application servers.

4. Select the server.

   

5. Go to Java and Process Management > Process Definition.
   

6. Select Java Virtual Machine.
   

7. In Generic JVM arguments, add the following arguments.

   -javaagent:path/to/vunet-opentelemetry-javaagent.jar -Dotel.resource.attributes=application=<APPLICATION_NAME> -Dotel.service.name=<SERVICE_NAME> -Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=<TRACES_INGESTION_ENDPOINT> -Dotel.exporter.otlp.compression=gzip

8. Please update the following before saving the configuration

   • APPLICATION_NAME: Change it to match your application name
   • SERVICE_NAME:
     • Change it to match the service name (microservices) or application layer (monolithic).
     • When multiple war files are running in a single Weblogic server, then enable the auto discovery of service name using the argument

       -Dotel.service.name=FROM_WEB_CONTEXT

   • TRACES_INGESTION_ENDPOINT: Change it to match the URL of the vuSmartMaps. It should be http://<vuSmartMaps Server IP>:4317

9. Save the configuration and restart the server.

Docker

If your application is running in Docker, then modify the Dockerfile to include the JVM parameters mentioned above.

See the extract from a sample Dockerfile.

COPY ./vunet-opentelemetry-javaagent.jar /usr/local/lib/vunet-opentelemetry-javaagent.jar
ENV JAVA_TOOL_OPTIONS "-javaagent:/usr/local/lib/vunet-opentelemetry-javaagent.jar"
ENV OTEL_RESOURCE_ATTRIBUTES "application=<Application Name>"
ENV OTEL_SERVICE_NAME "<Service Name>"
ENV OTEL_EXPORTER_OTLP_ENDPOINT "<TRACES_INGESTION_ENDPOINT>"
ENV OTEL_METRICS_EXPORTER "none"
ENTRYPOINT ["java","-Djava.security.egd=file:/dev/urandom","-jar","./app.jar", "--port=80"]

If you don’t want to rebuild the container, then you can re-run the container with the following additional environment variables.

docker run -d \
-v ./vunet-opentelemetry-javaagent.jar:/app/opentelemetry-javaagent.jar \
-e OTEL_EXPORTER_OTLP_ENDPOINT=<TRACES_INGESTION_ENDPOINT>\
-e OTEL_SERVICE_NAME=<Service Name> \
--entrypoint java \
-javaagent:/usr/local/lib/vunet-opentelemetry-javaagent.jar \
-jar /app/myapp.jar

Ensure to update the following before using this command.

• APPLICATION_NAME: Change it to match your application name
• SERVICE_NAME: Change it to match the service name (microservices) or application layer (monolithic)
• TRACES_INGESTION_ENDPOINT: Change it to match the URL of the vuSmartMaps. It should be http://<vuSmartMaps Server IP>:4317

Configuration

TLS Configuration

If the TLS is enabled on the vuSmartMaps traces receiver, please get the certificate from the server and configure the following additional parameters.

-Dotel.exporter.otlp.protocol=http/protobuf
-Dotel.exporter.otlp.certificate='/path/to/server/certificate'

note

The server certificate is included in the downloaded instrumentation package.

For the TLS case TRACES_INGESTION_ENDPOINT should be https://<vuSmartMaps Server IP>:4318

Capture HTTP Headers

In some applications, key transaction identifiers are passed as HTTP headers to the APIs. To capture these headers, additional instrumentation configurations are required. Below are the steps and examples for capturing HTTP headers for both HTTP servers and clients.

Capture HTTP Request Header for HTTP Server

To capture the request headers passed to a service, use the following configuration along with other instrumentation configurations mentioned in the previous sections.

OTEL_INSTRUMENTATION_HTTP_SERVER_CAPTURE_REQUEST_HEADERS

You can configure one or more headers to be captured. If capturing multiple headers, separate them with commas.

An example is given below

java -javaagent:vunet-opentelemetry-javaagent.jar
-Dotel.resource.attributes=application=UPI -Dotel.service.name=upi-switch
-Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=http://10.0.0.1:4317 -jar 
-Dotel.instrumentation.http.server.capture-request-headers=client_id,txn_id
upi.jar

Capture HTTP Response Header for HTTP Server

To capture the response headers passed from a service, use the following configuration along with other instrumentation configurations mentioned in the previous sections.

OTEL_INSTRUMENTATION_HTTP_SERVER_CAPTURE_RESPONSE_HEADERS

You can configure one or more headers to be captured. If capturing multiple headers, separate them with commas.

An example is given below

java -javaagent:vunet-opentelemetry-javaagent.jar
-Dotel.resource.attributes=application=UPI -Dotel.service.name=upi-switch
-Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=http://10.0.0.1:4317 -jar 
-Dotel.instrumentation.http.server.capture-response-headers=resp_code,resp_status
upi.jar

Capture HTTP Request Header for HTTP Client

To capture the request headers passed by a service, use the following configuration along with other instrumentation configurations mentioned in the previous sections.

OTEL_INSTRUMENTATION_HTTP_CLIENT_CAPTURE_REQUEST_HEADERS

You can configure one or more headers to be captured. If capturing multiple headers, separate them with commas.

An example is given below

java -javaagent:vunet-opentelemetry-javaagent.jar
-Dotel.resource.attributes=application=UPI -Dotel.service.name=upi-switch
-Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=http://10.0.0.1:4317 -jar 
-Dotel.instrumentation.http.client.capture-request-headers=client_id,txn_id
upi.jar

Capture HTTP Response Header for HTTP Client

To capture the response headers received by a service, use the following configuration along with other instrumentation configurations mentioned in the previous sections

OTEL_INSTRUMENTATION_HTTP_CLIENT_CAPTURE_RESPONSE_HEADERS

You can configure one or more headers to be captured. If capturing multiple headers, separate them with commas.

An example is given below

java -javaagent:vunet-opentelemetry-javaagent.jar
-Dotel.resource.attributes=application=UPI -Dotel.service.name=upi-switch
-Dotel.metrics.exporter=none -Dotel.exporter.otlp.endpoint=http://10.0.0.1:4317 -jar 
-Dotel.instrumentation.http.client.capture-response-headers=resp_code,resp_status
upi.jar

C# / .NET

Instrumentation Process

.NET Core 3.1 Application

1. The .NET Core 3.1 application does not support full auto instrumentation. It is partial auto instrumentation, which means code changes are required. The code changes are related to initializing the open telemetry.

2. Add the Open telemetry packages

   <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.8.1" />
   <PackageReference Include="OpenTelemetry.Exporter.Console" Version="1.8.1" />
   <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.8.1" />
   <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.8.1" />
   <PackageReference Include="OpenTelemetry.Instrumentation.SqlClient" Version="1.8.0-beta.1" />
   <PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="1.8.0" />
   <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.8.1" />

3. Add Open telemetry service. In the Startup.cs add the below code

services.AddOpenTelemetry()
.ConfigureResource(resource => resource.AddService(serviceName))
            .WithTracing(tracing => tracing
                           .AddAspNetCoreInstrumentation()
                           .AddHttpClientInstrumentation()
                           .AddOtlpExporter()
                           );

4. Make sure you include the required packages

   using OpenTelemetry;
   using OpenTelemetry.Resources;
   using OpenTelemetry.Trace;
   using OpenTelemetry.Exporter;

5. Set the following environment variables

   • OTEL_EXPORTER_OTLP_ENDPOINT with value “http://<vuSmartMaps Server IP>:4318”
   • OTEL_EXPORTER_OTLP_PROTOCOL with value “http/protobuf”
   • OTEL_RESOURCE_ATTRIBUTES with value “application=<APPLICATION_NAME>”
   • OTEL_SERVICE_NAME with value “<SERVICE_NAME>”

6. Build the application and run it.

.NET Application Running in Linux / MacOS (.NET Core)

1. Download the instrumentation package from the O11ysource and extract it to your favorite folder. This is the OTel home directory.

2. Install opentelemetry core files by running the bash script install.sh. This will install it in the dist folder.

3. Activate the auto instrumentation by running the following commands

   chmod +x dist/instrument.sh
   export OTEL_DOTNET_AUTO_HOME=dist
   . dist/instrument.sh

4. This sets the required environment variables to the current terminal session.

5. Set the following environment variables in the same terminal session

   • OTEL_EXPORTER_OTLP_ENDPOINT with value “http://<vuSmartMaps Server IP>:4318”
   • OTEL_EXPORTER_OTLP_PROTOCOL with value “http/protobuf”
   • OTEL_RESOURCE_ATTRIBUTES with value “application=<APPLICATION_NAME>”
   • OTEL_SERVICE_NAME with value “<SERVICE_NAME>”

6. In the same terminal session, run the .NET application.

Remove the instrumentation

1. Go to the OTel Home directory

2. Run the following commands

   chmod +x remove_instrumentation.sh
   . ./remove_instrumentation.sh

3. This removes the instrumentation, and you can run the application as usual.

.NET Application Running on Container (.NET Core)

1. Modify the Dockerfile to include the following lines to enable opentelemetry auto instrumentation

   # install OpenTelemetry .NET Automatic Instrumentation
   ARG OTEL_VERSION=1.4.0
   ADD https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/download/v${OTEL_VERSION}/otel-dotnet-auto-install.sh otel-dotnet-auto-install.sh
   RUN apt-get update && apt-get install -y curl
   RUN apt-get update && apt-get install -y unzip && \
      OTEL_DOTNET_AUTO_HOME="/otel-dotnet-auto" sh otel-dotnet-auto-install.sh

2. Build the docker image

3. Create a file called otel-dotnet.env with the following content

   # enable OpenTelemetry .NET Automatic Instrumentation
   CORECLR_ENABLE_PROFILING="1"
   CORECLR_PROFILER='{918728DD-259F-4A6A-AC2B-B85E1B658318}'
   CORECLR_PROFILER_PATH="/otel-dotnet-auto/linux-x64/OpenTelemetry.AutoInstrumentation.Native.so"
   DOTNET_ADDITIONAL_DEPS="/otel-dotnet-auto/AdditionalDeps"
   DOTNET_SHARED_STORE="/otel-dotnet-auto/store"
   DOTNET_STARTUP_HOOKS="/otel-dotnet-auto/net/OpenTelemetry.AutoInstrumentation.StartupHook.dll"
   OTEL_DOTNET_AUTO_HOME="/otel-dotnet-auto"

4. Run the Docker image with the following environment variables and env file

   -env-file ./otel-dotnet.env --env OTEL_EXPORTER_OTLP_ENDPOINT="http://<vuSmartMaps Server IP>:4318" OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf" OTEL_RESOURCE_ATTRIBUTES="application=<APPLICATION_NAME>" OTEL_SERVICE_NAME="<SERVICE_NAME>"

ASP.NET Application running in IIS (.NET Framework & .NET Core)

1. Download the instrumentation package (dotnet_auto_instrumentation_offline_package.zip) from the O11ysource and extract it.

2. Open Powershell in administrator mode. Go into the folder where the instrumentation packages are extracted.

3. Install open telemetry auto instrumentation by running the powershell script OpenTelemetry.DotNet.Auto.psm1

   # Import the module
   Import-Module ".\OpenTelemetry.DotNet.Auto.psm1"
   
   # Install core files
   Install-OpenTelemetryCore -InstallDir "C:\Program Files\OpenTelemetry .NET AutoInstrumentation" -LocalPath ".\opentelemetry-dotnet-instrumentation-windows.zip"

   By default, this is installed in the “C:\Program Files\OpenTelemetry .NET AutoInstrumentation” directory. You can install this in any folder by changing the “InstallDir” option

4. Run the command Register-OpenTelemetryForIIS. This will restart the IIS.

   # Setup IIS instrumentation
   Register-OpenTelemetryForIIS
   
   Security warning
   Run only scripts that you trust. While scripts from the internet can be useful, this script can potentially harm your computer. If
   you trust this script, use the Unblock-File cmdlet to allow the script to run without this warning message. Do you want to run
   D:\Dev\dotnet-instrumentation\madrid\instrumentation-package\dotnet\auto-instrumentation\pkg\otel\OpenTelemetry.DotNet.Auto.psm1?
   [D] Do not run  [R] Run once  [S] Suspend  [?] Help (default is "D"): R
   
   Attempting stop...
   Internet services successfully stopped
   Attempting start...
   Internet services successfully restarted

5. Set the setting to the application.

   • For .NET Framework applications.

     • Using IIS manager, open the “Application Settings” of your application
     • Add the following application settings.
       • OTEL_EXPORTER_OTLP_ENDPOINT with value “http://<vuSmartMaps Server IP>:4318”
       • OTEL_EXPORTER_OTLP_PROTOCOL with value “http/protobuf”
       • OTEL_RESOURCE_ATTRIBUTES with value “application=<APPLICATION_NAME>,host.name=<host_name>,host.ip=<host_ip>”
       • OTEL_SERVICE_NAME with value “<SERVICE_NAME>”
       • OTEL_METRICS_EXPORTER with value “none”
       • OTEL_DOTNET_AUTO_TRACES_WCFSERVICE_INSTRUMENTATION_ENABLED with value “false”
     • You can also set these values in the <appSettings> section in the Web.config file. An example is shown below.

   • For .NET Core applications.

     • Add the following application settings under the <environmentVariables> in <aspNetCore> section in web.config file
       • OTEL_EXPORTER_OTLP_ENDPOINT with value “http://<vuSmartMaps Server IP>:4318”
       • OTEL_EXPORTER_OTLP_PROTOCOL with value “http/protobuf”
       • OTEL_RESOURCE_ATTRIBUTES with value “application=<APPLICATION_NAME>,host.name=<host_name>,host.ip=<host_ip>”
       • OTEL_SERVICE_NAME with value “<SERVICE_NAME>”
       • OTEL_METRICS_EXPORTER with value “none”

     Example:

        <aspNetCore processPath="dotnet" arguments=".\WebApplication2.dll" stdoutLogEnabled="true" stdoutLogFile=".\logs\stdout" hostingModel="inprocess" >
           <environmentVariables>
                    <environmentVariable name="OTEL_EXPORTER_OTLP_ENDPOINT" value="http://<vuSmartMaps Server IP>:4318" />
        <environmentVariable name="OTEL_EXPORTER_OTLP_PROTOCOL" value="http/protobuf" />
              <environmentVariable name="OTEL_METRICS_EXPORTER" value="none" />
              <environmentVariable name="OTEL_SERVICE_NAME" value="<SERVICE_NAME>" />
              <environmentVariable name="OTEL_RESOURCE_ATTRIBUTES" value="application=<APPLICATION_NAME>,host.name=<HOST_NAME>,host.ip=<HOST_IP>" />
           </environmentVariables>
              </aspNetCore>

6. Restart IIS

Enable / Disable Instrumentation per Application Pool (.NET Framework only)

By default, all the applications are instrumented. But you can disable instrumentation per application pool.

# Import the module
Import-Module ".\OpenTelemetry.DotNet.Auto.psm1"

# Disable the instrumentation for the app pool
Disable-OpenTelemetryForIISAppPool -AppPoolName <App_Pool_Name>

# Restart Application Pool
Restart-WebAppPool -Name "MyAppPool"

To enable the instrumentation for the Application Pool, you can use the below command

# Import the module
Import-Module ".\OpenTelemetry.DotNet.Auto.psm1"

# Disable the instrumentation for the app pool
Enable-OpenTelemetryForIISAppPool -AppPoolName <App_Pool_Name>

# Restart Application Pool
Restart-WebAppPool -Name "MyAppPool"

Remove Instrumentation

1. Run the following commands to remove the instrumentation.

   # Import the module
   Import-Module ".\OpenTelemetry.DotNet.Auto.psm1"
   
   Unregister-OpenTelemetryForIIS
   
   Uninstall-OpenTelemetryCore

.NET Application running as exe in Terminal

1. Download the instrumentation package (dotnet_auto_instrumentation_offline_package.zip) from O11ysources and extract it.

2. Open Powershell in administrator mode. Go into the folder where the instrumentation packages are extracted.

3. Install open telemetry auto instrumentation by running the powershell script OpenTelemetry.DotNet.Auto.psm1

   # Import the module
   Import-Module ".\OpenTelemetry.DotNet.Auto.psm1"
   
   # Install core files
   Install-OpenTelemetryCore -InstallDir "C:\Program Files\OpenTelemetry .NET AutoInstrumentation" -LocalPath ".\opentelemetry-dotnet-instrumentation-windows.zip"

   By default, this is installed in the “C:\Program Files\OpenTelemetry .NET AutoInstrumentation” directory. You can install this any folder by changing the “InstallDir” option

4. Run the command Register-OpenTelemetryForCurrentSession

   Register-OpenTelemetryForCurrentSession -OTelServiceName "<service name>"

5. Set the following environment variables

   # Set environment variables for OpenTelemetry
   $env:OTEL_EXPORTER_OTLP_ENDPOINT = "http://<vuSmartMaps Server IP>:4318"
   $env:OTEL_EXPORTER_OTLP_PROTOCOL = "http/protobuf"
   $env:OTEL_METRICS_EXPORTER = "none"
   $env:OTEL_SERVICE_NAME = "<SERVICE_NAME>"
   $env:OTEL_RESOURCE_ATTRIBUTES = "application=<APPLICATION_NAME>,host.name=<HOST_NAME>,host.ip=<HOST_IP>"

6. Run the application exe

Uninstall Open telemetry for exe

1. Install open telemetry auto instrumentation by running the powershell script OpenTelemetry.DotNet.Auto.psm1

   # Import the module
   Import-Module ".\OpenTelemetry.DotNet.Auto.psm1"
   
   Unregister-OpenTelemetryForCurrentSession
   
   Uninstall-OpenTelemetryCore
   
   Remove-Item -Path env:OTEL_EXPORTER_OTLP_ENDPOINT
   Remove-Item -Path env:OTEL_EXPORTER_OTLP_PROTOCOL
   Remove-Item -Path env:OTEL_METRICS_EXPORTER
   Remove-Item -Path env:OTEL_SERVICE_NAME
   Remove-Item -Path env:OTEL_RESOURCE_ATTRIBUTES

.NET Application running as exe in Task Scheduler

1. Download the instrumentation package (dotnet_auto_instrumentation_offline_package.zip) from O11ysources and extract it.

2. Open Powershell in administrator mode. Go into the folder where the instrumentation packages are extracted.

3. Install open telemetry auto instrumentation by running the powershell script OpenTelemetry.DotNet.Auto.psm1

   # Import the module
   Import-Module ".\OpenTelemetry.DotNet.Auto.psm1"
   
   # Install core files
   Install-OpenTelemetryCore -InstallDir "C:\Program Files\OpenTelemetry .NET AutoInstrumentation" -LocalPath ".\opentelemetry-dotnet-instrumentation-windows.zip"

   By default, this is installed in the “C:\Program Files\OpenTelemetry .NET AutoInstrumentation” directory. You can install this in any folder by changing the “InstallDir” option

4. Create a wrapper PowerShell script to wrap your exe

   # Configure the Service Name
   $OTelServiceName = "SERVICE_NAME"
   
   # Configure the OTel installation path
   $installDir = "C:\Program Files\OpenTelemetry .NET AutoInstrumentation"
   
   # Configure your exe path
   $exePath = "C:\MyDotNetApp.exe"
   
   # Configure the resource attributes
   $applicationName = "APPLICATION_NAME"
   $hostName = "HOST_NAME"
   $hostIp = "HOST_IP"
   
   # Configure OpenTelemetry Exporter settings
   $otelExporterOtlpEndpoint = "http://<vuSmartMaps Server IP>:4318"
   $otelExporterOtlpProtocol = "http/protobuf"
   $otelMetricsExporter = "none"
   
   $otelResourceAttributes = "application=$applicationName,host.name=$hostName,host.ip=$hostIp"
   
   # Create the environment variables directly in the script
   $varsTable = @{
      "OTEL_SERVICE_NAME" = $OTelServiceName
      "OTEL_RESOURCE_ATTRIBUTES" = $otelResourceAttributes
      "OTEL_EXPORTER_OTLP_ENDPOINT" = $otelExporterOtlpEndpoint
      "OTEL_EXPORTER_OTLP_PROTOCOL" = $otelExporterOtlpProtocol
      "OTEL_METRICS_EXPORTER" = $otelMetricsExporter
      "COR_ENABLE_PROFILING" = "1"
      "COR_PROFILER" = "{918728DD-259F-4A6A-AC2B-B85E1B658318}"
      "COR_PROFILER_PATH_64" = "$installDir\win-x64\OpenTelemetry.AutoInstrumentation.Native.dll"
      "COR_PROFILER_PATH_32" = "$installDir\win-x86\OpenTelemetry.AutoInstrumentation.Native.dll"
      "CORECLR_ENABLE_PROFILING" = "1"
      "CORECLR_PROFILER" = "{918728DD-259F-4A6A-AC2B-B85E1B658318}"
      "CORECLR_PROFILER_PATH_32" = "$installDir\win-x86\OpenTelemetry.AutoInstrumentation.Native.dll"
      "CORECLR_PROFILER_PATH_64" = "$installDir\win-x64\OpenTelemetry.AutoInstrumentation.Native.dll"
      "ASPNETCORE_HOSTINGSTARTUPASSEMBLIES" = "OpenTelemetry.AutoInstrumentation.AspNetCoreBootstrapper"
      "DOTNET_ADDITIONAL_DEPS" = "$installDir\AdditionalDeps"
      "DOTNET_SHARED_STORE" = "$installDir\store"
      "DOTNET_STARTUP_HOOKS" = "$installDir\net\OpenTelemetry.AutoInstrumentation.StartupHook.dll"
      "OTEL_DOTNET_AUTO_HOME" = $installDir
   }
   
   # Set environment variables for the current session
   foreach ($var in $varsTable.Keys) {
      [System.Environment]::SetEnvironmentVariable($var, $varsTable[$var], [System.EnvironmentVariableTarget]::Process)
   }
   
   # Run the .NET application
   & $exePath

   Configure the following to match your environment

   • Service Name - Configure the correct SERVICE_NAME
   • Install Dir - Configure the correct install directory of OTel
   • Exe Path - Make sure you mention the correct path of the exe
   • Application Name - Provide the correct application name
   • Host Name - You can provide the host name. If you dont need host name then remove it from $otelResourceAttributes = "application=$applicationName,host.name=$hostName,host.ip=$hostIp"
   • Host IP - You can provide the host ip. If you dont need host name then remove it from $otelResourceAttributes = "application=$applicationName,host.name=$hostName,host.ip=$hostIp"
   • OTel Exporter Otlp Endpoint - Change this to the OTel collector endpoint

5. Modify your task

   • Open Task Scheduler and find your task.
   • Right-click the task and select Properties.
   • Go to the Actions tab and click Edit.
   • In the Action section, choose Start a program.
   • For the Program/script, enter the full path to powershell.exe. The path is typically “C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe”
   • In the Add arguments (optional) field, enter the following
     • -ExecutionPolicy Bypass -File "<full path of the wrapper powershell script you created>"

   Example:

   -ExecutionPolicy Bypass -File "C:\Myne\instrument-exe\MyDotNetApp\MyApp.ps1"

   

Uninstall Open telemetry for exe running in Task Scheduler

1. Uninstall open telemetry auto instrumentation by running the powershell script OpenTelemetry.DotNet.Auto.psm1

   # Import the module
   Import-Module ".\OpenTelemetry.DotNet.Auto.psm1"
   
   Uninstall-OpenTelemetryCore

2. Modify your task
   • Open Task Scheduler and find your task.
   • Right-click the task and select Properties.
   • Go to the Actions tab and click Edit.
   • In the Action section, choose Start a program.
   • For the Program/script, enter your exe path and save.

Configuration

Capture HTTP Headers

In some applications, key transaction identifiers are passed as HTTP headers to the APIs. To capture these headers, additional instrumentation configurations are required. Below are the steps and examples for capturing HTTP headers for both HTTP servers and clients.

Capture HTTP Request Header for ASP.NET Core

To capture the request headers of ASP.NET Core, use the following configuration along with other instrumentation configurations mentioned in the previous sections.

OTEL_DOTNET_AUTO_TRACES_ASPNETCORE_INSTRUMENTATION_CAPTURE_REQUEST_HEADERS

You can configure one or more headers to be captured. If capturing multiple headers, separate them with commas. Based on the environment, add this additional configuration. For example

OTEL_DOTNET_AUTO_TRACES_ASPNETCORE_INSTRUMENTATION_CAPTURE_REQUEST_HEADERS=client_id,applicationid

Capture HTTP Response Header for ASP.NET Core

To capture the response headers of ASP.NET Core, use the following configuration along with other instrumentation configurations mentioned in the previous sections.

OTEL_DOTNET_AUTO_TRACES_ASPNETCORE_INSTRUMENTATION_CAPTURE_RESPONSE_HEADERS

You can configure one or more headers to be captured. If capturing multiple headers, separate them with commas. Based on the environment, add this additional configuration. For example

OTEL_DOTNET_AUTO_TRACES_ASPNETCORE_INSTRUMENTATION_CAPTURE_REQUEST_HEADERS=respo_code,resp_status

Capture HTTP Request Header for ASP.NET

To capture the request headers of ASP.NET, use the following configuration along with other instrumentation configurations mentioned in the previous sections.

OTEL_DOTNET_AUTO_TRACES_ASPNET_INSTRUMENTATION_CAPTURE_REQUEST_HEADERS

You can configure one or more headers to be captured. If capturing multiple headers, separate them with commas. Based on the environment, add this additional configuration. For example

OTEL_DOTNET_AUTO_TRACES_ASPNET_INSTRUMENTATION_CAPTURE_REQUEST_HEADERS=client_id,applicationid

Capture HTTP Response Header for ASP.NET

To capture the response headers of ASP.NE, use the following configuration along with other instrumentation configurations mentioned in the previous sections.

OTEL_DOTNET_AUTO_TRACES_ASPNET_INSTRUMENTATION_CAPTURE_RESPONSE_HEADERS

You can configure one or more headers to be captured. If capturing multiple headers, separate them with commas. Based on the environment, add this additional configuration. For example

OTEL_DOTNET_AUTO_TRACES_ASPNET_INSTRUMENTATION_CAPTURE_RESPONSE_HEADERS=respo_code,resp_status

Kubernetes

Instrumentation Process

1. Download the Opentelemetry Operator helm chart from O11ysources and install it

   helm install opentelemetry-operator opentelemetry-operator-0.71.0.tgz \
   --namespace opentelemetry-operator-system \
   --create-namespace \
   --set "manager.collectorImage.repository=otel/opentelemetry-collector-k8s" \
   --set admissionWebhooks.certManager.enabled=false \
   --set admissionWebhooks.autoGenerateCert.enabled=true

2. Download the vuTraces auto instrumentation helm chart from O11ysources and install it

   helm install vutraces-auto-instrumentation vutraces-auto-instrumentation-1.0.0.tgz \
   --namespace opentelemetry-operator-system \
   --create-namespace \
   --set vutracesexporter.endpoint="http://<vuSmartMaps_server:4317"

3. Add the following annotation to your deployments.

   1. Java workloads

      annotations:
         instrumentation.opentelemetry.io/inject-java: "opentelemetry-operator-system/vutraces-auto-instrumentation"

   2. .NET workloads

      annotations:
         instrumentation.opentelemetry.io/inject-dotnet: "opentelemetry-operator-system/vutraces-auto-instrumentation"

   3. Go workloads

      annotations:
         instrumentation.opentelemetry.io/inject-go: "opentelemetry-operator-system/vutraces-auto-instrumentation"

      If there are multiple containers exists in the pod, then add the below annotation too

      annotations:
         instrumentation.opentelemetry.io/container-names: <name of the application container>

   4. If you have a limited number of deployments in your cluster, modify your application helm charts or k8s manifests. In the deployment add the annotation in spec -> template -> metadata

   5. If you have many deployments and it is not possible to manually update them then do some automation. One such automation script is available here. Please use this as a reference and create an automation script that works for your environment.

   6. The annotations can be also added at the namespace

4. Add the following environment variable in the deployment to set the application name.

   name: OTEL_RESOURCE_ATTRIBUTES
      value: "application=<app_name>"