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.

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

chore(opencensus): deprecate opencensus module #364

Merged
merged 2 commits into from
Dec 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 3 additions & 3 deletions docs/1. Flamingo Basics/5. Flamingo Production.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ CMD ["serve"]
[Read more about the ZAP Logger in Flamingo](../3. Core Modules/Zap.md)


### OpenCensus
### OpenTelemetry

For metrics support and to push tracing informations to Jaeger/Zipkin Flamingo uses opencensus.
[Read more about Opencensus](../2. Framework Modules/Opencensus Tracing.md)
For metrics support and to push tracing information to Jaeger/Zipkin Flamingo uses OpenTelemetry.
[Read more about OpenTelemetry](../3. Flamingo Modules/opentelemetry.md)
2 changes: 1 addition & 1 deletion docs/1. Flamingo Basics/7. Flamingo Bootstrap.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ func main() {
new(prefixrouter.Module),
new(pugtemplate.Module),
new(locale.Module),
new(opencensus.Module),
new(opentelemetry.Module),
new(auth.Module),

//flamingo-commerce modules
Expand Down
2 changes: 1 addition & 1 deletion docs/1. Flamingo Basics/8. Coding Conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The Context is always the first argument to a method/function.
Do not check, and do not pass, nil contexts, as they are forbidden!
Do not use the context for general passing of scoped data, unless it's explicit necessary.

Use the opencensus/tags package for tracing/stats tags.
Use the opentelemetry/tags package for tracing/stats tags.

## Public interfaces and methods

Expand Down
2 changes: 2 additions & 0 deletions framework/opencensus/Readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Opencensus

> **This module is deprecated and will likely be removed in future versions of flamingo. Please use the [OpenTelemetry module](https://github.com/i-love-flamingo/opentelemetry) instead.**

## General usage

First, if you're not sure what opencensus is, please visit [https://opencensus.io/](https://opencensus.io/) to learn more about it.
Expand Down
3 changes: 2 additions & 1 deletion framework/opencensus/module.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ func (rt *correlationIDInjector) RoundTrip(req *http.Request) (*http.Response, e
return rt.next.RoundTrip(req)
}

// Module registers the opencensus module which in turn enables jaeger & co
// Module registers the opencensus module which in turn enables jaeger & co.
// Deprecated: OpenCensus was discontinued in favor of OpenTelemetry, please use flamingo.me/opentelemetry instead.
type Module struct {
endpoint string
serviceName string
Expand Down