Skip to content

Commit

Permalink
Merge pull request #424 from signalfx/deprecation
Browse files Browse the repository at this point in the history
Add deprecation notice to top README
  • Loading branch information
breedx-splk authored Jan 30, 2024
2 parents 4369813 + baa6cdd commit 6363d44
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,36 +12,35 @@

# SignalFx client libraries

This repository contains legacy libraries for instrumenting Java applications and
reporting metrics to Splunk Observability Cloud (formerly SignalFx).
# :warning: This repository and its published libraries are deprecated

This repository contains legacy libraries for reporting metrics to Splunk
Observability Cloud (formerly SignalFx). The only commits that will be made
to this repo are organizational or security related patches. No additional
features will be added, and the repository will be archived and the final
versions published on or prior to February 1, 2025.

* :warning: `signalfx-codahale` will be deleted in July 2024.
* :warning: `signalfx-yammer` will be deleted in July 2024.
* :warning: Everything else will be archived February 1st 2025.

Splunk has adopted OpenTelemetry. Use the
[OpenTelemetry Java SDK](https://github.com/open-telemetry/opentelemetry-java) or
the [Splunk Distribution of OpenTelemetry Java Instrumentation](https://github.com/signalfx/splunk-otel-java)
agent to send telemetry data to Splunk. Do not integrate `signalfx-java`
into new services.

## Do not use this library in your project

You should not use this library in new services.
Use [OpenTelemetry](https://github.com/open-telemetry/opentelemetry-java) to send data to Splunk instead.

To send data to Splunk, you need a Splunk Observability Cloud account and organization
API token. For more information on Observability Cloud and to create an
account, go to [Splunk Observability](https://www.splunk.com/en_us/products/observability.html).

## Language compatibility

* Java 8 and higher

## Using this library in your project

You are discouraged from integrating this library into new services.
Use [OpenTelemetry](https://github.com/open-telemetry/opentelemetry-java) to send data
to Splunk instead.

Legacy documentation is still here for posterity: [legacy-usage.md](legacy-usage.md).

## Deprecations

* :warning: `signalfx-codahale` will be deleted in July 2024.
* :warning: `signalfx-yammer` will be deleted in July 2024.

# Executing SignalFlow computations

[Learn more about using SignalFlow here](signalflow.md).
Expand Down

0 comments on commit 6363d44

Please sign in to comment.