Skip to content

Commit

Permalink
Deprecate writer package (#209)
Browse files Browse the repository at this point in the history
  • Loading branch information
pellared authored Apr 18, 2024
1 parent 54b2f6b commit 6a8afc1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
5 changes: 4 additions & 1 deletion writer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
See the [godoc](https://godoc.org/github.com/signalfx/signalfx-go/writer) for
information on what they are and how to use them.

> [!WARNING]
> `writer` package is **deprecated** and will reach End of Support on October 18, 2024.
> Use OpenTelemetry Go instead.
## Compiling

The buffer and writer are generated from a common template in the [`template`](./template)
Expand All @@ -13,4 +17,3 @@ install the code generation tool with `go get github.com/mauricelam/genny`.
Also, `span_[writer|buffer]_test.go` is automatically generated from
`datapoint_[writer|buffer]_test.go` by the same `go generate` command, so be
sure to make changes in the datapoint test module.

2 changes: 2 additions & 0 deletions writer/internal.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
// request at a time to ingest/gateway is probably not going to get enough
// throughput, as usually the network and HTTP RTT is the bottleneck at that
// point.
//
// Deprecated: Use OpenTelemetry Go instead.
package writer

//go:generate sh -c "cd template && ./gen.sh"
Expand Down

0 comments on commit 6a8afc1

Please sign in to comment.