From 5047953ce15b4373ae37c1b0472cb8e93e490809 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Wed, 24 Apr 2024 18:26:45 +0200 Subject: [PATCH 1/4] Depracate signalflow --- signalflow/README.md | 4 ++++ signalflow/doc.go | 2 ++ signalflow/go.mod | 1 + 3 files changed, 7 insertions(+) diff --git a/signalflow/README.md b/signalflow/README.md index 6b9e922..2155084 100644 --- a/signalflow/README.md +++ b/signalflow/README.md @@ -3,6 +3,10 @@ This is a client for [SignalFlow](https://dev.splunk.com/observability/docs/signalflow) that lets you stream and analyze metric data in real-time for your organization. +> [!WARNING] +> `github.com/signalfx/signalfx-go/signalflow/v2` package is **deprecated**. +> Use [`github.com/signalfx/signalflow-client-go/signalflow`](https://pkg.go.dev/github.com/signalfx/signalflow-client-go/signalflow) instead. + ## Installation **You must use Go 1.19+ for the v2 of this client.** diff --git a/signalflow/doc.go b/signalflow/doc.go index ac147e4..8b739e8 100644 --- a/signalflow/doc.go +++ b/signalflow/doc.go @@ -8,4 +8,6 @@ // after a short delay. // // SignalFlow is documented at https://dev.splunk.com/observability/docs/signalflow/messages. +// +// Deprecated: Use github.com/signalfx/signalflow-client-go/signalflow instead. package signalflow diff --git a/signalflow/go.mod b/signalflow/go.mod index 1a3711f..ec53630 100644 --- a/signalflow/go.mod +++ b/signalflow/go.mod @@ -1,3 +1,4 @@ +// Deprecated: Use github.com/signalfx/signalflow-client-go/signalflow instead. module github.com/signalfx/signalfx-go/signalflow/v2 go 1.19 From 3303e131aeaa8cd114c9d98a38a43a6ff84b45df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Wed, 24 Apr 2024 18:40:27 +0200 Subject: [PATCH 2/4] Add nolint --- signalflow/example/main.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/signalflow/example/main.go b/signalflow/example/main.go index 32b4432..7b6f1dd 100644 --- a/signalflow/example/main.go +++ b/signalflow/example/main.go @@ -8,7 +8,7 @@ import ( "os" "time" - "github.com/signalfx/signalfx-go/signalflow/v2" + "github.com/signalfx/signalfx-go/signalflow/v2" //nolint:staticcheck // Users should use github.com/signalfx/signalflow-client-go/signalflow instead. ) func main() { From b21e1cca7b8a106066896a0ca728baccf434e6da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Thu, 25 Apr 2024 07:45:57 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/README.md b/README.md index 199edd7..0bbd3dd 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,6 @@ This is a programmatic interface in Go for SignalFx's metadata and ingest APIs. -# SignalFlow - -There is an **experimental** SignalFlow client in the `signalflow` directory. An -example of its use is in [signalflow/example]. For full documentation see the -[godocs](https://godoc.org/github.com/signalfx/signalfx-go/signalflow). - # Example ``` From 67fb10f430901a10c27085890e4af2ada0960ca1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Thu, 25 Apr 2024 07:50:03 +0200 Subject: [PATCH 4/4] Update new module path --- signalflow/README.md | 2 +- signalflow/doc.go | 2 +- signalflow/go.mod | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/signalflow/README.md b/signalflow/README.md index 2155084..ddea6c3 100644 --- a/signalflow/README.md +++ b/signalflow/README.md @@ -5,7 +5,7 @@ you stream and analyze metric data in real-time for your organization. > [!WARNING] > `github.com/signalfx/signalfx-go/signalflow/v2` package is **deprecated**. -> Use [`github.com/signalfx/signalflow-client-go/signalflow`](https://pkg.go.dev/github.com/signalfx/signalflow-client-go/signalflow) instead. +> Use [`github.com/signalfx/signalflow-client-go/v2/signalflow`](https://pkg.go.dev/github.com/signalfx/signalflow-client-go/v2/signalflow) instead. ## Installation diff --git a/signalflow/doc.go b/signalflow/doc.go index 8b739e8..57d6c02 100644 --- a/signalflow/doc.go +++ b/signalflow/doc.go @@ -9,5 +9,5 @@ // // SignalFlow is documented at https://dev.splunk.com/observability/docs/signalflow/messages. // -// Deprecated: Use github.com/signalfx/signalflow-client-go/signalflow instead. +// Deprecated: Use github.com/signalfx/signalflow-client-go/v2/signalflow instead. package signalflow diff --git a/signalflow/go.mod b/signalflow/go.mod index ec53630..cefd2a4 100644 --- a/signalflow/go.mod +++ b/signalflow/go.mod @@ -1,4 +1,4 @@ -// Deprecated: Use github.com/signalfx/signalflow-client-go/signalflow instead. +// Deprecated: Use github.com/signalfx/signalflow-client-go/v2/signalflow instead. module github.com/signalfx/signalfx-go/signalflow/v2 go 1.19