Help us shape the future of Go! Take the 2026 Go Developer Survey

telemetryapi

package
v0.3.3 Latest Latest
Warning

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

 Go to latest Published: Oct 26, 2026 License: AGPL-3.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithServerURL 

func WithServerURL(ctx context.Context, u *url.URL) context.Context

WithServerURL sets context key to override server URL.

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client implements OAS client.

func NewClient 

func NewClient(serverURL string, opts ...ClientOption) (*Client, error)

NewClient initializes new Client defined by OAS.

func (*Client) TelemetryReportsSubmit 

func (c *Client) TelemetryReportsSubmit(ctx context.Context, request *TelemetryReport) error

TelemetryReportsSubmit invokes TelemetryReports_submit operation.

Receives one Telemetry report. The receiver stores no source address.

POST /v1/reports

type ClientOption 

type ClientOption interface {
	// contains filtered or unexported methods
}

ClientOption is client config option.

func WithClient 

func WithClient(client ht.Client) ClientOption

WithClient specifies http client to use.

type Invoker 

type Invoker interface {
	// TelemetryReportsSubmit invokes TelemetryReports_submit operation.
	//
	// Receives one Telemetry report. The receiver stores no source address.
	//
	// POST /v1/reports
	TelemetryReportsSubmit(ctx context.Context, request *TelemetryReport) error
}

Invoker invokes operations described by OpenAPI v3 specification.

type OperationName 

type OperationName = string

OperationName is the ogen operation name 

const (
	TelemetryReportsSubmitOperation OperationName = "TelemetryReportsSubmit"
)

type Option 

type Option interface {
	ClientOption
}

Option is config option.

func WithAttributes 

func WithAttributes(attributes ...attribute.KeyValue) Option

WithAttributes specifies default otel attributes.

func WithMeterProvider 

func WithMeterProvider(provider metric.MeterProvider) Option

WithMeterProvider specifies a meter provider to use for creating a meter.

If none is specified, the otel.GetMeterProvider() is used.

func WithTracerProvider 

func WithTracerProvider(provider trace.TracerProvider) Option

WithTracerProvider specifies a tracer provider to use for creating a tracer.

If none is specified, the global provider is used.

type OrderOfMagnitude 

type OrderOfMagnitude string

A count rounded to its order of magnitude, never an exact number. Ref: #/components/schemas/OrderOfMagnitude 

const (
	OrderOfMagnitude0            OrderOfMagnitude = "0"
	OrderOfMagnitude19           OrderOfMagnitude = "1-9"
	OrderOfMagnitude1099         OrderOfMagnitude = "10-99"
	OrderOfMagnitude100999       OrderOfMagnitude = "100-999"
	OrderOfMagnitude10009999     OrderOfMagnitude = "1000-9999"
	OrderOfMagnitude1000099999   OrderOfMagnitude = "10000-99999"
	OrderOfMagnitude100000999999 OrderOfMagnitude = "100000-999999"
	OrderOfMagnitude1000000      OrderOfMagnitude = "1000000+"
)

func (OrderOfMagnitude) AllValues 

func (OrderOfMagnitude) AllValues() []OrderOfMagnitude

AllValues returns all OrderOfMagnitude values.

func (*OrderOfMagnitude) Decode 

func (s *OrderOfMagnitude) Decode(d *jx.Decoder) error

Decode decodes OrderOfMagnitude from json.

func (OrderOfMagnitude) Encode 

func (s OrderOfMagnitude) Encode(e *jx.Encoder)

Encode encodes OrderOfMagnitude as json.

func (OrderOfMagnitude) MarshalJSON 

func (s OrderOfMagnitude) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OrderOfMagnitude) MarshalText 

func (s OrderOfMagnitude) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*OrderOfMagnitude) UnmarshalJSON 

func (s *OrderOfMagnitude) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*OrderOfMagnitude) UnmarshalText 

func (s *OrderOfMagnitude) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (OrderOfMagnitude) Validate 

func (s OrderOfMagnitude) Validate() error

type TelemetryDeployShape 

type TelemetryDeployShape string

Ref: #/components/schemas/TelemetryDeployShape 

const (
	TelemetryDeployShapeBinary     TelemetryDeployShape = "binary"
	TelemetryDeployShapeContainer  TelemetryDeployShape = "container"
	TelemetryDeployShapeKubernetes TelemetryDeployShape = "kubernetes"
	TelemetryDeployShapeUnknown    TelemetryDeployShape = "unknown"
)

func (TelemetryDeployShape) AllValues 

func (TelemetryDeployShape) AllValues() []TelemetryDeployShape

AllValues returns all TelemetryDeployShape values.

func (*TelemetryDeployShape) Decode 

func (s *TelemetryDeployShape) Decode(d *jx.Decoder) error

Decode decodes TelemetryDeployShape from json.

func (TelemetryDeployShape) Encode 

func (s TelemetryDeployShape) Encode(e *jx.Encoder)

Encode encodes TelemetryDeployShape as json.

func (TelemetryDeployShape) MarshalJSON 

func (s TelemetryDeployShape) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (TelemetryDeployShape) MarshalText 

func (s TelemetryDeployShape) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*TelemetryDeployShape) UnmarshalJSON 

func (s *TelemetryDeployShape) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TelemetryDeployShape) UnmarshalText 

func (s *TelemetryDeployShape) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (TelemetryDeployShape) Validate 

func (s TelemetryDeployShape) Validate() error

type TelemetryEdition 

type TelemetryEdition string

Ref: #/components/schemas/TelemetryEdition 

const (
	TelemetryEditionCore TelemetryEdition = "core"
	TelemetryEditionEe   TelemetryEdition = "ee"
)

func (TelemetryEdition) AllValues 

func (TelemetryEdition) AllValues() []TelemetryEdition

AllValues returns all TelemetryEdition values.

func (*TelemetryEdition) Decode 

func (s *TelemetryEdition) Decode(d *jx.Decoder) error

Decode decodes TelemetryEdition from json.

func (TelemetryEdition) Encode 

func (s TelemetryEdition) Encode(e *jx.Encoder)

Encode encodes TelemetryEdition as json.

func (TelemetryEdition) MarshalJSON 

func (s TelemetryEdition) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (TelemetryEdition) MarshalText 

func (s TelemetryEdition) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*TelemetryEdition) UnmarshalJSON 

func (s *TelemetryEdition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TelemetryEdition) UnmarshalText 

func (s *TelemetryEdition) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (TelemetryEdition) Validate 

func (s TelemetryEdition) Validate() error

type TelemetryIntegrationKind 

type TelemetryIntegrationKind string

Ref: #/components/schemas/TelemetryIntegrationKind 

const (
	TelemetryIntegrationKindSMTP TelemetryIntegrationKind = "smtp"
	TelemetryIntegrationKindSes  TelemetryIntegrationKind = "ses"
)

func (TelemetryIntegrationKind) AllValues 

func (TelemetryIntegrationKind) AllValues() []TelemetryIntegrationKind

AllValues returns all TelemetryIntegrationKind values.

func (*TelemetryIntegrationKind) Decode 

func (s *TelemetryIntegrationKind) Decode(d *jx.Decoder) error

Decode decodes TelemetryIntegrationKind from json.

func (TelemetryIntegrationKind) Encode 

func (s TelemetryIntegrationKind) Encode(e *jx.Encoder)

Encode encodes TelemetryIntegrationKind as json.

func (TelemetryIntegrationKind) MarshalJSON 

func (s TelemetryIntegrationKind) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (TelemetryIntegrationKind) MarshalText 

func (s TelemetryIntegrationKind) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*TelemetryIntegrationKind) UnmarshalJSON 

func (s *TelemetryIntegrationKind) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TelemetryIntegrationKind) UnmarshalText 

func (s *TelemetryIntegrationKind) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (TelemetryIntegrationKind) Validate 

func (s TelemetryIntegrationKind) Validate() error

type TelemetryLocale 

type TelemetryLocale string

Ref: #/components/schemas/TelemetryLocale 

const (
	TelemetryLocaleEn TelemetryLocale = "en"
)

func (TelemetryLocale) AllValues 

func (TelemetryLocale) AllValues() []TelemetryLocale

AllValues returns all TelemetryLocale values.

func (*TelemetryLocale) Decode 

func (s *TelemetryLocale) Decode(d *jx.Decoder) error

Decode decodes TelemetryLocale from json.

func (TelemetryLocale) Encode 

func (s TelemetryLocale) Encode(e *jx.Encoder)

Encode encodes TelemetryLocale as json.

func (TelemetryLocale) MarshalJSON 

func (s TelemetryLocale) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (TelemetryLocale) MarshalText 

func (s TelemetryLocale) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*TelemetryLocale) UnmarshalJSON 

func (s *TelemetryLocale) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TelemetryLocale) UnmarshalText 

func (s *TelemetryLocale) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (TelemetryLocale) Validate 

func (s TelemetryLocale) Validate() error

type TelemetryReport 

type TelemetryReport struct {
	// The version of this schema the report was built against.
	SchemaVersion int32 `json:"schemaVersion"`
	// A random value stored in the Instance's database, derived from nothing.
	InstanceId string `json:"instanceId"`
	// The release version of the running binary, for example `1.4.2`.
	AppVersion string           `json:"appVersion"`
	Edition    TelemetryEdition `json:"edition"`
	// The operating system the binary runs on (Go's GOOS), for example `linux`.
	Os string `json:"os"`
	// The CPU architecture the binary runs on (Go's GOARCH), for example `arm64`.
	Arch        string               `json:"arch"`
	DeployShape TelemetryDeployShape `json:"deployShape"`
	// The major version of the Postgres server, for example `17`.
	PostgresMajor int32 `json:"postgresMajor"`
	// The Instance's configured locale.
	Locale TelemetryLocale `json:"locale"`
	// Whole days since the Instance was first started.
	InstanceAgeDays int32            `json:"instanceAgeDays"`
	Workspaces      OrderOfMagnitude `json:"workspaces"`
	// Identified Contacts, excluding erased ones.
	Contacts OrderOfMagnitude `json:"contacts"`
	// Emails sent in the last 30 days.
	EmailsSent30d OrderOfMagnitude `json:"emailsSent30d"`
	// A Broadcast was sent in the last 30 days.
	UsedBroadcasts30d bool `json:"usedBroadcasts30d"`
	// At least one Automation is active.
	AutomationsActive bool `json:"automationsActive"`
	// The tracker recorded a visit in the last 30 days.
	UsedTracker30d bool `json:"usedTracker30d"`
	// An external API token was used in the last 30 days.
	UsedExternalApi30d bool `json:"usedExternalApi30d"`
	// At least one webhook endpoint is configured.
	WebhooksConfigured bool `json:"webhooksConfigured"`
	// The kinds of sending Integration in use, each at most once.
	IntegrationKinds []TelemetryIntegrationKind `json:"integrationKinds"`
}

What an Instance reports about itself. It carries no name, domain, address, host, error text, licence key or exact number, and nothing that identifies a Workspace or a person. A new field is a change to this schema and to its documentation in the same commit. Ref: #/components/schemas/TelemetryReport

func (*TelemetryReport) Decode 

func (s *TelemetryReport) Decode(d *jx.Decoder) error

Decode decodes TelemetryReport from json.

func (*TelemetryReport) Encode 

func (s *TelemetryReport) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*TelemetryReport) GetAppVersion 

func (s *TelemetryReport) GetAppVersion() string

GetAppVersion returns the value of AppVersion.

func (*TelemetryReport) GetArch 

func (s *TelemetryReport) GetArch() string

GetArch returns the value of Arch.

func (*TelemetryReport) GetAutomationsActive 

func (s *TelemetryReport) GetAutomationsActive() bool

GetAutomationsActive returns the value of AutomationsActive.

func (*TelemetryReport) GetContacts 

func (s *TelemetryReport) GetContacts() OrderOfMagnitude

GetContacts returns the value of Contacts.

func (*TelemetryReport) GetDeployShape 

func (s *TelemetryReport) GetDeployShape() TelemetryDeployShape

GetDeployShape returns the value of DeployShape.

func (*TelemetryReport) GetEdition 

func (s *TelemetryReport) GetEdition() TelemetryEdition

GetEdition returns the value of Edition.

func (*TelemetryReport) GetEmailsSent30d 

func (s *TelemetryReport) GetEmailsSent30d() OrderOfMagnitude

GetEmailsSent30d returns the value of EmailsSent30d.

func (*TelemetryReport) GetInstanceAgeDays 

func (s *TelemetryReport) GetInstanceAgeDays() int32

GetInstanceAgeDays returns the value of InstanceAgeDays.

func (*TelemetryReport) GetInstanceId 

func (s *TelemetryReport) GetInstanceId() string

GetInstanceId returns the value of InstanceId.

func (*TelemetryReport) GetIntegrationKinds 

func (s *TelemetryReport) GetIntegrationKinds() []TelemetryIntegrationKind

GetIntegrationKinds returns the value of IntegrationKinds.

func (*TelemetryReport) GetLocale 

func (s *TelemetryReport) GetLocale() TelemetryLocale

GetLocale returns the value of Locale.

func (*TelemetryReport) GetOs 

func (s *TelemetryReport) GetOs() string

GetOs returns the value of Os.

func (*TelemetryReport) GetPostgresMajor 

func (s *TelemetryReport) GetPostgresMajor() int32

GetPostgresMajor returns the value of PostgresMajor.

func (*TelemetryReport) GetSchemaVersion 

func (s *TelemetryReport) GetSchemaVersion() int32

GetSchemaVersion returns the value of SchemaVersion.

func (*TelemetryReport) GetUsedBroadcasts30d 

func (s *TelemetryReport) GetUsedBroadcasts30d() bool

GetUsedBroadcasts30d returns the value of UsedBroadcasts30d.

func (*TelemetryReport) GetUsedExternalApi30d 

func (s *TelemetryReport) GetUsedExternalApi30d() bool

GetUsedExternalApi30d returns the value of UsedExternalApi30d.

func (*TelemetryReport) GetUsedTracker30d 

func (s *TelemetryReport) GetUsedTracker30d() bool

GetUsedTracker30d returns the value of UsedTracker30d.

func (*TelemetryReport) GetWebhooksConfigured 

func (s *TelemetryReport) GetWebhooksConfigured() bool

GetWebhooksConfigured returns the value of WebhooksConfigured.

func (*TelemetryReport) GetWorkspaces 

func (s *TelemetryReport) GetWorkspaces() OrderOfMagnitude

GetWorkspaces returns the value of Workspaces.

func (*TelemetryReport) MarshalJSON 

func (s *TelemetryReport) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TelemetryReport) SetAppVersion 

func (s *TelemetryReport) SetAppVersion(val string)

SetAppVersion sets the value of AppVersion.

func (*TelemetryReport) SetArch 

func (s *TelemetryReport) SetArch(val string)

SetArch sets the value of Arch.

func (*TelemetryReport) SetAutomationsActive 

func (s *TelemetryReport) SetAutomationsActive(val bool)

SetAutomationsActive sets the value of AutomationsActive.

func (*TelemetryReport) SetContacts 

func (s *TelemetryReport) SetContacts(val OrderOfMagnitude)

SetContacts sets the value of Contacts.

func (*TelemetryReport) SetDeployShape 

func (s *TelemetryReport) SetDeployShape(val TelemetryDeployShape)

SetDeployShape sets the value of DeployShape.

func (*TelemetryReport) SetEdition 

func (s *TelemetryReport) SetEdition(val TelemetryEdition)

SetEdition sets the value of Edition.

func (*TelemetryReport) SetEmailsSent30d 

func (s *TelemetryReport) SetEmailsSent30d(val OrderOfMagnitude)

SetEmailsSent30d sets the value of EmailsSent30d.

func (*TelemetryReport) SetInstanceAgeDays 

func (s *TelemetryReport) SetInstanceAgeDays(val int32)

SetInstanceAgeDays sets the value of InstanceAgeDays.

func (*TelemetryReport) SetInstanceId 

func (s *TelemetryReport) SetInstanceId(val string)

SetInstanceId sets the value of InstanceId.

func (*TelemetryReport) SetIntegrationKinds 

func (s *TelemetryReport) SetIntegrationKinds(val []TelemetryIntegrationKind)

SetIntegrationKinds sets the value of IntegrationKinds.

func (*TelemetryReport) SetLocale 

func (s *TelemetryReport) SetLocale(val TelemetryLocale)

SetLocale sets the value of Locale.

func (*TelemetryReport) SetOs 

func (s *TelemetryReport) SetOs(val string)

SetOs sets the value of Os.

func (*TelemetryReport) SetPostgresMajor 

func (s *TelemetryReport) SetPostgresMajor(val int32)

SetPostgresMajor sets the value of PostgresMajor.

func (*TelemetryReport) SetSchemaVersion 

func (s *TelemetryReport) SetSchemaVersion(val int32)

SetSchemaVersion sets the value of SchemaVersion.

func (*TelemetryReport) SetUsedBroadcasts30d 

func (s *TelemetryReport) SetUsedBroadcasts30d(val bool)

SetUsedBroadcasts30d sets the value of UsedBroadcasts30d.

func (*TelemetryReport) SetUsedExternalApi30d 

func (s *TelemetryReport) SetUsedExternalApi30d(val bool)

SetUsedExternalApi30d sets the value of UsedExternalApi30d.

func (*TelemetryReport) SetUsedTracker30d 

func (s *TelemetryReport) SetUsedTracker30d(val bool)

SetUsedTracker30d sets the value of UsedTracker30d.

func (*TelemetryReport) SetWebhooksConfigured 

func (s *TelemetryReport) SetWebhooksConfigured(val bool)

SetWebhooksConfigured sets the value of WebhooksConfigured.

func (*TelemetryReport) SetWorkspaces 

func (s *TelemetryReport) SetWorkspaces(val OrderOfMagnitude)

SetWorkspaces sets the value of Workspaces.

func (*TelemetryReport) UnmarshalJSON 

func (s *TelemetryReport) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TelemetryReport) Validate 

func (s *TelemetryReport) Validate() error

type TelemetryReportsSubmitNoContent 

type TelemetryReportsSubmitNoContent struct{}

TelemetryReportsSubmitNoContent is response for TelemetryReportsSubmit operation.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.