Table of Contents

Integration overview

The integration path is the same for every runtime, even though the package and the configuration idiom differ:

flowchart LR
  Account["Create a Reignite account"] --> App["Create an application"]
  App --> Env["Create an environment"]
  Env --> Profiler["Create a profiler"]
  Profiler --> Copy["Copy the configuration block"]
  Copy --> Install["Install the agent"]
  Install --> Deploy["Deploy and breach a threshold"]
  Deploy --> Review["Review the trace in the portal"]

Choose your runtime

Runtime Package Where it is published Guide
.NET / ASP.NET Core Reignite.Profiler.AspNetCore NuGet Profiler for .NET
Java com.reignite:profiler Maven coordinates; the public catalogue currently marks the agent as coming soon Profiler for Java
Node.js @reignite/profiler npm package name; the public catalogue currently marks the agent as coming soon Profiler for Node.js
Python reignite-profiler Repository and package source; not part of the public profiler catalogue Profiler for Python

The public Profilers page is the authority for whether an agent is installable. Repository-ready and published are different states; the guides below say which one applies.

The common configuration model

Every agent is configured with the same concepts, even though the key names differ:

Concept What it means
ProfilerID The identifier of the profiler instance created in the portal.
KeyID The API-key identifier the agent presents when it authenticates.
Secret The secret paired with KeyID. Treat it like a password.
Environment The environment name the profiler reports under (for example, Production).
Refresh interval How often a running agent re-reads its configuration.
Dump / trace wait The minimum time between collected artifacts, so a single noisy metric cannot fill the disk or the account.
Threshold actions The metric, comparison, threshold and collection type (trace, dump or both).
Cooldown The per-action delay before the same action may fire again.

Where the data goes

  • Metrics and configuration travel over HTTPS to the Reignite API.
  • Trace files, heap dumps and thread dumps are uploaded to Azure Blob Storage. The API records the artifact metadata and issues time-limited SAS URLs for downloads.
  • The trace file is what an analyst claims. Its lifecycle is documented in the trace file lifecycle flow.

Before you install

  1. Create an account and an application in the portal.
  2. Create an environment and a profiler, and copy the generated configuration block.
  3. Store the configuration in your application's own secret or settings mechanism. Never commit KeyID or Secret to source control.
  4. Keep the polling interval in mind: if you change EventCounterIntervalSec, the threshold values that were tuned for the old interval need to be re-tuned. For example, a counter that counts events per interval roughly doubles its count when the interval doubles.

Next steps