prometheus

README

GoZix Prometheus

Dependencies

• zap
• viper

Configuration example

{
  "prometheus": {
    "host": "0.0.0.0",
    "port": 8683,
    "path": "/metrics"
  }
}

Flags

--prometheus-port - Prometheus metrics port. The same `prometheus.port` config, but with high priority.

Documentation

Index

• Constants
• Variables
• type Bundle
  • func NewBundle(options ...Option) *Bundle
  • func (b *Bundle) Build(builder *di.Builder) error
  • func (b *Bundle) DependsOn() []string
  • func (b *Bundle) Name() string
• type Option
  • func Registry(registry *prometheus.Registry) Option

Constants

const (
	// BundleName is default definition name.
	BundleName = "prometheus"
	// // TagCollectorProvider is alias of component.TagCollectorProvider.
	TagCollectorProvider = component.TagCollectorProvider
)

Variables

var DefRegistryName = component.DefRegistryName

DefRegistryName is a internal registry definition name

Types

type Bundle

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

Bundle implements the glue.Bundle interface.

func NewBundle

func NewBundle(options ...Option) *Bundle

NewBundle create bundle instance.

func (*Bundle) Build

func (b *Bundle) Build(builder *di.Builder) error

Build implements the glue.Bundle interface.

func (*Bundle) DependsOn

func (b *Bundle) DependsOn() []string

DependsOn implements the glue.DependsOn interface.

func (*Bundle) Name

func (b *Bundle) Name() string

Name is key implements the glue.Bundle interface.

type Option

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

Option interface.

func Registry

func Registry(registry *prometheus.Registry) Option

Registry option makes it possible to set a custom registry.