contrib/

directory
v1.32.0-rc.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 22, 2021 License: Apache-2.0, BSD-3-Clause, Apache-2.0

README

Godoc

The purpose of these packages is to provide tracing on top of commonly used packages from the standard library as well as the community in a "plug-and-play" manner. This means that by simply importing the appropriate path, functions are exposed having the same signature as the original package. These functions return structures which embed the original return value, allowing them to be used as they normally would with tracing activated out of the box.

All of these libraries are supported by our APM product.

⚠ These libraries are not built to be used with Opentracing. Opentracing integrations can be found in their own organisation.

Usage

First, find the library which you'd like to integrate with. The naming convention for the integration packages is:

  • If the package is from the standard library (eg. database/sql), it will be located at the same path.
  • If the package is hosted on Github (eg. github.com/user/repo) and has version v2.1.0, it will be located at the shorthand path user/repo.v2.
  • If the package is from anywhere else (eg. google.golang.org/grpc) and has no stable version, it can be found under the full import path, followed by the version suffix (in this example .v0).
  • All new integrations should be suffixed with .vN where N is the major version that is being covered.
  • The package itself should retain its un-versioned name. For example, the integration under user/repo.v2 stays as package repo, and does not become package repo.v2

Each integration comes with thorough documentation and usage examples. A good overview can be seen on our godoc page.

Directories

Path Synopsis
Shopify
aws
bradfitz
cloud.google.com
confluentinc
database
emicklei
garyburd
gin-gonic
globalsign
go-chi
go-pg
go-redis
go.mongodb.org
Package gocql provides functions to trace the gocql/gocql package (https://github.com/gocql/gocql).
Package gocql provides functions to trace the gocql/gocql package (https://github.com/gocql/gocql).
gofiber
gomodule
google.golang.org
gopkg.in
gorilla
gorm.io
graph-gophers
hashicorp
internal
jinzhu
jmoiron
julienschmidt
k8s.io
labstack
miekg
net
olivere
syndtr
tidwall
twitchtv
zenazn

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL