Telescope

NexusTelescopeApplicationBuilderExtensionsCopy Anchor Link

static class Inverge.Nexus.AspNetCore.NexusTelescopeApplicationBuilderExtensions

Wires Nexus Telescope into the ASP.NET Core pipeline.

UseNexusTelescope()Copy Anchor Link

static IApplicationBuilder UseNexusTelescope(IApplicationBuilder app)

Adds request details to each Telescope journey. Put it early in the pipeline (before routing/auth so it wraps them). Requires services.AddNexusTelescope().

Parameters

Returns IApplicationBuilder

NexusTelescopeMiddlewareCopy Anchor Link

class Inverge.Nexus.AspNetCore.NexusTelescopeMiddleware

Adds the request's details to its Telescope journey: method, URL, headers, query, body, response status/headers/body, the matched route pattern, the user, and any unhandled exception. (The journey itself — and every query, HttpClient call and log inside it — is recorded by NexusTelescope.)

NexusTelescopeMiddlewareCopy Anchor Link

new NexusTelescopeMiddleware(RequestDelegate next, NexusTelescope telescope)

Creates the middleware.

Parameters

InvokeAsync()Copy Anchor Link

Task InvokeAsync(HttpContext context)

Runs the middleware.

Parameters

NexusTelescopeCopy Anchor Link

class Inverge.Nexus.Telescope.NexusTelescope

Nexus Telescope for .NET — records every unit of work (an ASP.NET Core request, a message consumer, a job or command you wrap) and everything it did, and ships the journeys to the Nexus console.

It listens to Activity, which the runtime and most libraries already emit: ASP.NET Core requests, HttpClient calls (with W3C traceparent propagation, so downstream services join the trace), Npgsql, MassTransit, the Azure SDKs… EF Core and SqlClient queries come from their DiagnosticListener events; log records from the ILogger provider. Your own work: Span, RunAsync``1.

Nothing here throws into the application.

NexusTelescopeCopy Anchor Link

new NexusTelescope(INexusClient client, TelescopeOptions? options = null)

Creates the recorder. Call Start to begin listening (the DI registration does).

Parameters

Traceparent()Copy Anchor Link

static string? Traceparent()

A W3C traceparent for the current point — put it on a message so its consumer joins the trace.

Returns string?

BodyLimitBytesCopy Anchor Link

int BodyLimitBytes { get; }

The body capture limit in bytes.

IsEnabledCopy Anchor Link

bool IsEnabled { get; }

Whether recording is on: options, the service switch, and the console's pause.

IsRecordingCopy Anchor Link

bool IsRecording { get; }

Whether a unit of work is being recorded at the current point.

OptionsCopy Anchor Link

TelescopeOptions Options { get; }

The options in effect.

SourceCopy Anchor Link

static ActivitySource Source

The ActivitySource Telescope's own spans and jobs are created from.

Discard()Copy Anchor Link

void Discard()

Stops recording the current unit of work and drops it (e.g. an ignored path).

Dispose()Copy Anchor Link

void Dispose()

Enrich()Copy Anchor Link

void Enrich(IDictionary<string, object?> content)

Adds fields to the current unit of work's own record (the request, the job…).

Parameters

FlushAsync()Copy Anchor Link

Task FlushAsync(CancellationToken cancellationToken = default)

Ships everything finished so far.

Parameters

IgnoresPath()Copy Anchor Link

bool IgnoresPath(string path)

Whether a request path is ignored (options + console settings).

Parameters

Returns bool

Log()Copy Anchor Link

void Log(string level, string message, IDictionary<string, object?>? context = null)

Records a log line in the current journey.

Parameters

Record()Copy Anchor Link

void Record(string type, IDictionary<string, object?> content, double? durationMs = null, string? status = null, string? name = null)

Records an entry in the current journey.

Parameters

RecordException()Copy Anchor Link

void RecordException(Exception exception, bool handled = true)

Records an exception in the current journey. Unhandled ones fail it.

Parameters

RecordQuery()Copy Anchor Link

void RecordQuery(string sql, IEnumerable<object?>? bindings, double durationMs, string? connection = null)

Records a query you ran outside EF Core / ADO.NET instrumentation.

Parameters

RunAsync()Copy Anchor Link

Task<T?> RunAsync<T>(string type, string name, Func<Task<T?>> work, string? traceparent = null, IDictionary<string, object?>? content = null)

Runs work as its own journey — a job, command or scheduled task. Pass the traceparent the producer put on the message (see Traceparent) so the run joins the producer's trace.

Parameters

Returns Task<T?>

RunAsync()Copy Anchor Link

Task RunAsync(string type, string name, Func<Task> work, string? traceparent = null, IDictionary<string, object?>? content = null)

Runs work as its own journey (see RunAsync``1).

Parameters

SetStatus()Copy Anchor Link

void SetStatus(string status)

Sets the status of the current unit of work (HTTP status, processed, an exit code…).

Parameters

SetUser()Copy Anchor Link

void SetUser(string id, string? email = null, string? name = null)

The signed-in user of the current journey: tags it Auth:<id> and links it to Nexus Sessions.

Parameters

Span()Copy Anchor Link

IDisposable Span(string name)

A named span: everything recorded inside it (queries, HTTP calls, logs — across awaits) nests under it. using (telescope.Span("pricing")) { … }

Parameters

Returns IDisposable

Start()Copy Anchor Link

void Start()

Starts listening and the background sender. Idempotent.

Tag()Copy Anchor Link

void Tag(string[] tags)

Tags the current journey.

Parameters

TelescopeLoggerProviderCopy Anchor Link

class Inverge.Nexus.Telescope.TelescopeLoggerProvider

Records log records into the journey they were written in (and only while a journey is open). A record carrying an exception becomes an exception entry.

TelescopeLoggerProviderCopy Anchor Link

new TelescopeLoggerProvider(NexusTelescope telescope)

Creates the provider.

Parameters

CreateLogger()Copy Anchor Link

ILogger CreateLogger(string categoryName)

Parameters

Returns ILogger

Dispose()Copy Anchor Link

void Dispose()

TelescopeOptionsCopy Anchor Link

class Inverge.Nexus.Telescope.TelescopeOptions

What Nexus Telescope records. Most of it can also be changed from the console without a deploy.

TelescopeOptionsCopy Anchor Link

new TelescopeOptions()

BodySizeLimitKbCopy Anchor Link

int BodySizeLimitKb { get; set; }

Largest body recorded, in KB. Default 64.

CaptureBodiesCopy Anchor Link

bool CaptureBodies { get; set; }

Record request/response bodies (JSON is parsed). Default true.

EnabledCopy Anchor Link

bool Enabled { get; set; }

Master switch (also NEXUS_TELESCOPE_ENABLED=false, or pausing it in the console).

FlushIntervalCopy Anchor Link

TimeSpan FlushInterval { get; set; }

How often finished journeys are shipped. Default 2 s.

IgnoreActivitySourcesCopy Anchor Link

IList<string> IgnoreActivitySources { get; }

ActivitySource names never turned into entries.

IgnorePathsCopy Anchor Link

IList<string> IgnorePaths { get; }

Request paths never recorded (globs, * = anything).

IgnoreTypesCopy Anchor Link

IList<string> IgnoreTypes { get; }

Entry types never recorded (log, cache, …).

MaxEntriesCopy Anchor Link

int MaxEntries { get; set; }

Entries kept per journey; the rest are counted. Default 2000.

MinimumLogLevelCopy Anchor Link

LogLevel MinimumLogLevel { get; set; }

Log records at or above this level become entries. Default Information.

RedactKeysCopy Anchor Link

IList<string> RedactKeys { get; }

Extra keys redacted from headers and payloads (passwords, tokens and cookies always are).

ReleaseCopy Anchor Link

string? Release { get; set; }

Release / version shown with each journey.

SampleRateCopy Anchor Link

double? SampleRate { get; set; }

Fraction of journeys kept, 0..1. null = the console's sample rate. Failed, slow and monitored journeys are always kept.

ServiceCopy Anchor Link

string? Service { get; set; }

The service name shown in traces. Default: NEXUS_SERVICE_NAME, else the entry assembly name.

TelescopeServiceCollectionExtensionsCopy Anchor Link

static class Inverge.Nexus.Telescope.TelescopeServiceCollectionExtensions

Registers Nexus Telescope.

AddNexusTelescope()Copy Anchor Link

static IServiceCollection AddNexusTelescope(IServiceCollection services, Action<TelescopeOptions>? configure = null, Action<NexusOptions>? configureNexus = null)

Adds Nexus Telescope: a singleton NexusTelescope that starts with the host and flushes on shutdown, and an ILogger provider that records log lines into journeys. Calls AddNexus() if it has not been. For ASP.NET Core also add app.UseNexusTelescope().

Parameters

Returns IServiceCollection