elastic/apm-agent-go

tracer: Improve godocs by providing one or two getting started examples

Open

#1,257 opened on Jun 2, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Go (208 forks)auto 404
agent-godocsgood first issue

Repository metrics

Stars
 (425 stars)
PR merge metrics
 (PR metrics pending)

Description

Description

It would be helpful to include one or two examples that show up in the godoc on how to create a new tracer from a constructed transport.HTTPTransport: https://pkg.go.dev/go.elastic.co/apm/v2@v2.1.0/transport#NewHTTPTransport.

Contributor guide

Research direction
Examine the existing godoc for transport.NewHTTPTransport and write a concise example showing how to create a tracer from it, following Go's example conventions.
Tech stack
go
Domain
backendapideveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90