Skip to content

Commit

Permalink
add deprecation notices to readmes (#1141)
Browse files Browse the repository at this point in the history
Update readmes for some sub-projects to indicate they are
deprecated and usage should be phased out.
  • Loading branch information
brharrington authored Jul 10, 2024
1 parent 374dadb commit b0fa0cc
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 0 deletions.
6 changes: 6 additions & 0 deletions spectator-ext-aws/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# spectator-ext-aws

**DEPRECATED:** AWS SDK for Java V1 will no longer be supported [after 2025]. Users
should move to AWS SDK for Java V2.

[after 2025]: https://aws.amazon.com/blogs/developer/announcing-end-of-support-for-aws-sdk-for-java-v1-x-on-december-31-2025/

Use Spectator as the Metrics backend for AWS SDK Request Metrics.

# Usage
Expand Down
4 changes: 4 additions & 0 deletions spectator-ext-log4j1/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## Description

**DEPRECATED:** Log4J 1.x has reached [end of life]. Users should move to Log4J 2.x.

[end of life]: https://news.apache.org/foundation/entry/apache_logging_services_project_announces

Report basic metrics summarizing the log volume. See [docs] for more information.

[docs]: https://netflix.github.io/spectator/en/latest/ext/log4j1/
Expand Down
2 changes: 2 additions & 0 deletions spectator-nflx-plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
## Description

**DEPRECATED:** Internal users should move to SBN.

Provides a module for use with Guice based applications running at Netflix.
See [docs] for more information.

Expand Down
3 changes: 3 additions & 0 deletions spectator-reg-metrics3/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
## Description

**DEPRECATED:** Use `spectator-reg-micrometer` for integration with other
systems not supported directly via a Spectator registry implementation.

Registry implementation that wraps the [Dropwizard Metrics] library.

[Dropwizard Metrics]: https://metrics.dropwizard.io/3.1.0/
Expand Down
3 changes: 3 additions & 0 deletions spectator-reg-metrics5/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
## Description

**DEPRECATED:** Use `spectator-reg-micrometer` for integration with other
systems not supported directly via a Spectator registry implementation.

Registry implementation that wraps the [Dropwizard Metrics] 5.x library.

[Dropwizard Metrics]: https://metrics.dropwizard.io/5.0.0-rc11/
Expand Down

0 comments on commit b0fa0cc

Please sign in to comment.