Instrumentation¶

Immersive APM offers support for the OpenTelemetry observailbity framework. This is the most common and easiest configuration for customers to get started.

The process is called instrumentation and OpenTelemetry provides an exhaustive amount of documentation for many mainstream programming langugages. The process of instrumentation with OpenTelemetry involves adding the OpenTelemetry SDK to the application's codebase and configuring it to collect telemetry data. The SDK provides APIs to capture telemetry data from various sources in the application, including traces, metrics, and logs. Once the SDK is integrated into the application, developers can configure it to export the collected telemetry data to various tools and platforms, such as my.immersivefusion.com or other observability tools. The OpenTelemetry collector is a component that can be used to receive, process, and export telemetry data from the application.

After instrumentation is completed Immersive APM will start collecting telemetry data from the software application to gain insights into its performance, behavior, and usage. This data can then be seen in the Immersive APM Web and Immersive APM 3D/VR clients.

Sending data to Immersive APM¶

Sending data to Immersive APM is easy! Configure your OTLP endpoint to otlp.immersivefusion.com and supply your API key.

New Customers¶

If you haven't already, start your subscription by choosing the plan right for you. Then, follow the steps to configure your acocunt:

1. Create a new tenant (What is this?)
2. Create a new billing profile (What is this?)
3. Create a new subscription (What is this?)
4. Create a new environment (What is this?)
5. Create a new (application) grid (What is this?)

Existing Customers¶

Once you have at least one grid created, click on the instrumentation button

Follow the wizard to create your application grid API key, instrument your application and test the instrumentation setup. If you application is already instrumented, you just need to take the API key.

The final piece is to specify your OTLP endpoint and API key. The code to do so will look different based on the language your application is written in. Here's C# example. Supply the API key to your application and deploy it. That's it!

C# example:

.AddOtlpExporter(o =>
{
    o.Endpoint = new Uri(this.Configuration["IfApmOtlpEndpoint"]);
    o.Headers = $"API-Key={this.Configuration["IfApmAPIKey"]}";
});

Enter your grid¶

Once you have configured, deployed and tested your instrumentation, Enter the World of Your Application ™ by either clicking the enter button in Immersive APM Web and Immersive APM 3D/VR to start seeing your traces and log information.

Summary¶

Instrumentation with the OpenTelemetry observability framework is a powerful tool for collecting telemetry data from software applications. It allows developers to use Immersive APM Web and Immersive APM 3D/VR clients and gain valuable insights into the application's performance, behavior, and usage, and make data-driven decisions to improve the application's functionality and user experience.