Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate signalflow #210

Merged
merged 4 commits into from
Apr 25, 2024
Merged

Deprecate signalflow #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5047953
Depracate signalflow
pellared Apr 24, 2024
3303e13
Add nolint
pellared Apr 24, 2024
b21e1cc
Update README.md
pellared Apr 25, 2024
67fb10f
Update new module path
pellared Apr 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

```
Expand Down
4 changes: 4 additions & 0 deletions signalflow/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/v2/signalflow`](https://pkg.go.dev/github.com/signalfx/signalflow-client-go/v2/signalflow) instead.

## Installation

**You must use Go 1.19+ for the v2 of this client.**
Expand Down
2 changes: 2 additions & 0 deletions signalflow/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/v2/signalflow instead.
package signalflow
2 changes: 1 addition & 1 deletion signalflow/example/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down
1 change: 1 addition & 0 deletions signalflow/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// Deprecated: Use github.com/signalfx/signalflow-client-go/v2/signalflow instead.
module github.com/signalfx/signalfx-go/signalflow/v2

go 1.19
Expand Down
Loading