SDKsObservability SDKsSDK features

Sending errors

Overview

The observability plugin automatically sends errors to LaunchDarkly. You can also use recordError to manually send a custom error.

Details about each SDK’s configuration are available in the SDK-specific sections below:

Viewing errors and sourcemaps

You can view all errors sent to LaunchDarkly under Errors in the LaunchDarkly user interface. To learn more, read Error monitoring.

If you are working with a client-side SDK and using the Errors page in LaunchDarkly to help debug an error, it’s helpful to have a stack trace from the original file in your codebase to help understand what is going wrong. To provide this, LaunchDarkly needs access to the sourcemaps from your codebase. You can send your sourcemaps to LaunchDarkly using the ldcli sourcemaps upload command in the LaunchDarkly CLI. To learn how, read Use ldcli for uploading sourcemaps.

Client-side SDKs

This feature is available in the observability plugin for the following client-side SDKs:

iOS

You can use recordError to manually send a custom error:

Record error
1LDObserve.shared.recordLog(message: message, severity: .info, attributes: attributes)

To learn more, read recordError.

Android

You can use recordError to manually send a custom error:

Record error
1LDObserve.recordError(error, attributes)

The attributes argument is optional. To construct it, use Attributes from the @opentelemetry/api.

JavaScript

You can use recordError to manually send a custom error:

Record error
1LDObserve.recordError(error, 'optional message', {
2  component: 'ExampleComponent.tsx',
3});

The message and payload arguments are optional. To learn more, read recordError.

React Native

You can use recordError to manually send a custom error:

Record error
1LDObserve.recordError(error, attributes, options);

The attributes and options arguments are optional. To construct them, use Attributes and OtelSpan from the @opentelemetry/api. To learn more, read recordError.

React Web

To send a custom error with the React Web SDK, follow the example for JavaScript.

Vue

To send a custom error with the React Web SDK, follow the example for JavaScript.

Server-side SDKs

This feature is available in the observability plugin for the following server-side SDKs:

.NET (server-side)

Use RecordError to manually send a custom error.

Here’s how:

Record error
1Observe.RecordException(exception, metadata)

You can optionally pass an array of attributes, which may include any attributes. We recommend using attributes from the OpenTelemetry specification. To learn more, read RecordLog.

Go

Use RecordError to manually record an error in the current span.

Here’s how:

Record error
1ldobserve.RecordError(ctx, err)

This function takes a Go context.Context and the error. You can optionally pass an array of additional attributes from the OpenTelemetry specification. To learn more, read RecordError.

Node.js (server-side)

Use recordError to manually send a custom error.

Here’s how:

Record error
1LDObserve.recordError(
2  error,
3  secureSessionId,
4  requestId,
5  metadata,
6  options
7});

The recordError method automatically provides trace context propagation, so you can leave the secureSessionId and requestId undefined. Alternatively, you have the option to set their values, to assist with the context propagation. You can parse values for secureSessionId and requestId from the incoming request using LDObserve.parseHeaders().

The optional metadata can include any attributes from the OpenTelemetry specification. To learn more, read recordError.

Python

Use record_exception to manually send a custom error.

Here’s how:

Record exception
1try:
2  # your application may raise an error
3except Exception as e:
4  observe.record_exception(e)

Passing the Exception records the exception contents and stack trace. You can optionally pass an array of additional Attributes, which may include any attributes from the OpenTelemetry specification. To learn more, read record_exception.