---
title: "OpenFeign Integration"
description: "Learn how to capture tracing information of OpenFeign-based HTTP clients."
url: https://docs.sentry.io/platforms/java/guides/spring/tracing/instrumentation/open-feign/
---

# OpenFeign Integration | Sentry for Spring

Capturing transactions requires that you first [set up tracing](https://docs.sentry.io/platforms/java/guides/spring/tracing.md) if you haven't already.

Sentry OpenFeign integration provides the `SentryFeignClient`, which creates a span for each outgoing HTTP request executed with a [Feign](https://github.com/OpenFeign/feign)-based HTTP client.

### [Install](https://docs.sentry.io/platforms/java/guides/spring/tracing/instrumentation/open-feign.md#install)

```xml
<dependency>
    <groupId>io.sentry</groupId>
    <artifactId>sentry-openfeign</artifactId>
    <version>8.58.0</version>
</dependency>
```

*Other available variations of the above snippet: Gradle, SBT*

For other dependency managers see the [central Maven repository](https://search.maven.org/artifact/io.sentry/sentry-openfeign).

## [Configure](https://docs.sentry.io/platforms/java/guides/spring/tracing/instrumentation/open-feign.md#configure)

Add `SentryCapability` to Feign builder:

```java
import feign.Feign;
import io.sentry.openfeign.SentryCapability;

YourApi api = Feign.builder()
    .addCapability(new SentryCapability())
    ...
    .target(YourApi.class, "https://your-api-host/");
```

*Other available variations of the above snippet: kotlin*

## [Control URL Query Parameters](https://docs.sentry.io/platforms/java/guides/spring/tracing/instrumentation/open-feign.md#control-url-query-parameters)

OpenFeign adds URLs to HTTP spans and breadcrumbs. Use [`dataCollection.urlQueryParams`](https://docs.sentry.io/platforms/java/guides/spring/configuration/options.md#dataCollection) to filter or omit their query parameters:

```java
import io.sentry.KeyValueCollectionBehavior;
import io.sentry.Sentry;

Sentry.init(
    options ->
        options
            .getDataCollection()
            .setUrlQueryParams(KeyValueCollectionBehavior.off()));
```

Configuring this field activates the Data Collection defaults for omitted fields. The base URL is still sent when query parameter collection is disabled.

## [Modify or Drop Spans](https://docs.sentry.io/platforms/java/guides/spring/tracing/instrumentation/open-feign.md#modify-or-drop-spans)

Spans created around HTTP requests can be modified or dropped using `SentryFeignClient.BeforeSpanCallback` passed to `SentryCapability`:

```java
import feign.Feign;
import io.sentry.openfeign.SentryCapability;

YourApi api = Feign.builder()
    .addCapability(
        new SentryCapability(
            (span, request, response) -> {
              // modify span or return `null` to drop
              if (request.url().endsWith("/todos")) {
                span.setTag("tag-name", "tag-value");
              }
              return span;
            }))
    ...
    .target(YourApi.class, "https://your-api-host/");
```

*Other available variations of the above snippet: kotlin*