services/friendbot: Instrument friendbot to emit traces #5796

satyamz · 2025-08-22T13:06:44Z

PR Checklist

PR Structure

This PR has reasonably narrow scope (if not, break it down into smaller PRs).
This PR avoids mixing refactoring changes with feature changes (split into two PRs
otherwise).
This PR's title starts with name of package that is most changed in the PR, ex.
services/friendbot, or all or doc if the changes are broad or impact many
packages.

Thoroughness

This PR adds tests for the most critical parts of the new functionality or fixes.
I've updated any docs (developer docs, .md
files, etc... affected by this change). Take a look in the docs folder for a given service,
like this one.

Release planning

I've reviewed the changes in this PR and if I consider them worthwhile for being mentioned on release notes then I have updated the relevant CHANGELOG.md within the component folder structure. For example, if I changed horizon, then I updated (services/horizon/CHANGELOG.md. I add a new line item describing the change and reference to this PR. If I don't update a CHANGELOG, I acknowledge this PR's change may not be mentioned in future release notes.
I've decided if this PR requires a new major/minor version according to
semver, or if it's mainly a patch change. The PR is targeted at the next
release branch if it's not a patch change.

What

services/friendbot: Instrument friendbot to emit traces. Traces will be sent to Grafana alloy which will send traces to Grafana tempo.

Why

We want to have an ability track request lifecycle
Help identify performance bottlenecks.

Known limitations

This PR updates several dependencies. We need land this carefully.

Issue:

https://github.com/stellar/ops/issues/4005

Signed-off-by: Satyam Zode <[email protected]>

socket-security · 2025-08-22T13:08:46Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	golang/github.com/go-chi/chi/v5@v5.1.0
	golang/go.opentelemetry.io/otel@v1.28.0 ⏵ v1.34.0	⁺¹
	golang/github.com/stretchr/testify@v1.9.0 ⏵ v1.10.0	⁺¹
	golang/go.opentelemetry.io/otel/sdk@v1.28.0 ⏵ v1.34.0	⁺¹
	golang/github.com/riandyrn/otelchi@v0.12.1
	golang/go.opentelemetry.io/otel/trace@v1.28.0 ⏵ v1.34.0	⁺¹

View full report

Copilot

Pull Request Overview

This PR instruments the friendbot service to emit OpenTelemetry traces that will be sent to Grafana Alloy and forwarded to Grafana Tempo for distributed tracing capabilities and performance monitoring.

Added a new utils/tracer package with OpenTelemetry configuration
Updated friendbot service to use context-aware tracing throughout the request lifecycle
Added OpenTelemetry middleware to the HTTP router for automatic request tracing

Reviewed Changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
utils/tracer/tracer.go	New utility package for OpenTelemetry tracer initialization and configuration
services/friendbot/main.go	Updated to initialize tracing, add OpenTelemetry middleware, and use chi/v5 router
services/friendbot/internal/friendbot_handler.go	Added tracing instrumentation to HTTP request handlers
services/friendbot/internal/friendbot.go	Updated Pay method to accept context for tracing
services/friendbot/internal/minion.go	Added context parameter and span instrumentation to minion operations
services/friendbot/internal/minion_test.go	Updated test functions to pass context parameter
services/friendbot/internal/friendbot_test.go	Updated test functions to pass context parameter
services/friendbot/friendbot.cfg	Added otel_endpoint configuration
go.mod	Updated dependencies to include OpenTelemetry packages and chi/v5

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-10T14:48:22Z

utils/tracer/tracer.go

+	)
+
+	if err != nil {
+		return nil, errors.Wrap(err, "failed to create exporter")


The error message 'failed to create exporter' is inconsistent with the previous error message on line 50 which says 'Error while creating exporter'. Consider using consistent messaging and grammar.

Suggested change

return nil, errors.Wrap(err, "failed to create exporter")

return nil, errors.Wrap(err, "Error while creating resource")

Copilot · 2025-09-10T14:48:22Z

services/friendbot/main.go

+	serviceVersion = "1.0.0" //TODO: Change version
 )



The TODO comment suggests this hardcoded version should be changed. Consider using build-time injection or reading from a version file to make version management more maintainable.

Suggested change

serviceVersion = "1.0.0" //TODO: Change version

)

)

// serviceVersion should be set at build time using -ldflags "-X main.serviceVersion=1.2.3"

var serviceVersion = "dev"

Copilot · 2025-09-10T14:48:22Z

services/friendbot/main.go

@@ -63,6 +72,15 @@ func run(cmd *cobra.Command, args []string) {
 		os.Exit(1)
 	}

+	//Setup and intialize tracer


Spelling error: 'intialize' should be 'initialize'.

Suggested change

//Setup and intialize tracer

//Setup and initialize tracer

Copilot · 2025-09-10T14:48:23Z

services/friendbot/internal/friendbot_handler.go

 	address := r.Form.Get("addr")
+	if address == "" {
+		span.SetStatus(codes.Error, "missing destination account address")
+		span.SetAttributes(attribute.String("error.type", "missing_parameter"))


This condition sets span status to error but doesn't return early, allowing execution to continue with an empty address which will likely cause issues downstream. The function should return an error when address is empty.

Suggested change

span.SetAttributes(attribute.String("error.type", "missing_parameter"))

span.SetAttributes(attribute.String("error.type", "missing_parameter"))

return "", problem.MakeInvalidFieldProblem("addr", nil)

satyamz added 7 commits August 20, 2025 13:53

Add stellar tracer to utils package

66d5939

Signed-off-by: Satyam Zode <[email protected]>

Add otelchi middleware for the go-chi middle

f4ed738

Signed-off-by: Satyam Zode <[email protected]>

Update go-chi package version

5d64356

Signed-off-by: Satyam Zode <[email protected]>

Add instrumentation for friendbot handler function

40e0e23

Signed-off-by: Satyam Zode <[email protected]>

Add insecure flag for exporter

c1d6b06

Signed-off-by: Satyam Zode <[email protected]>

Use handler with tracer

dd0155b

Signed-off-by: Satyam Zode <[email protected]>

Update instrumentation for friendbot

ea410df

Signed-off-by: Satyam Zode <[email protected]>

satyamz marked this pull request as ready for review September 10, 2025 14:47

Copilot AI review requested due to automatic review settings September 10, 2025 14:47

Merge branch 'master' into friendbot-instrumentation-03

b6e4969

Copilot AI reviewed Sep 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

services/friendbot: Instrument friendbot to emit traces #5796

services/friendbot: Instrument friendbot to emit traces #5796

Uh oh!

satyamz commented Aug 22, 2025

Uh oh!

socket-security bot commented Aug 22, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 10, 2025

Uh oh!

Copilot AI Sep 10, 2025

Uh oh!

Copilot AI Sep 10, 2025

Uh oh!

Copilot AI Sep 10, 2025

Uh oh!

Uh oh!

	return nil, errors.Wrap(err, "failed to create exporter")
	return nil, errors.Wrap(err, "Error while creating resource")

-	serviceVersion = "1.0.0" //TODO: Change version
-)
+)
+// serviceVersion should be set at build time using -ldflags "-X main.serviceVersion=1.2.3"
+var serviceVersion = "dev"

	span.SetAttributes(attribute.String("error.type", "missing_parameter"))
	span.SetAttributes(attribute.String("error.type", "missing_parameter"))
	return "", problem.MakeInvalidFieldProblem("addr", nil)

services/friendbot: Instrument friendbot to emit traces #5796

Are you sure you want to change the base?

services/friendbot: Instrument friendbot to emit traces #5796

Uh oh!

Conversation

satyamz commented Aug 22, 2025

PR Structure

Thoroughness

Release planning

What

Why

Known limitations

Issue:

Uh oh!

socket-security bot commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

socket-security bot commented Aug 22, 2025 •

edited

Loading