metrics

package

v0.16.2 Latest Latest Go to latest Published: Dec 4, 2021 License: GPL-3.0 Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/wabarc/wayback

Links

Open Source Insights

Documentation ¶

Overview ¶

Package metrics exposes wayback service status.

Index ¶

Constants
func IncrementPlayback(from, status string)
func IncrementPublish(desc, status string)
func IncrementWayback(from, status string)
type Collector
- func NewCollector() *Collector

Constants ¶

View Source

const (
	ServiceIRC      = "irc"
	ServiceWeb      = "web"
	ServiceSlack    = "slack"
	ServiceMatrix   = "matrix"
	ServiceDiscord  = "discord"
	ServiceMastodon = "mastodon"
	ServiceTelegram = "telegram"
	ServiceTwitter  = "twitter"

	PublishIRC     = "irc"      // IRC channel
	PublishChannel = "channel"  // Telegram channel
	PublishMstdn   = "mastodon" // Mastodon toot
	PublishGithub  = "github"   // GitHub issues
	PublishMatrix  = "room"
	PublishSlack   = "slack"
	PublishDiscord = "discord" // Discord channel
	PublishTwitter = "tweet"

	StatusRequest = "request"
	StatusSuccess = "success"
	StatusFailure = "failure"
)

Common status values

Variables ¶

This section is empty.

Functions ¶

func IncrementPlayback ¶

func IncrementPlayback(from, status string)

IncrementPlayback increments the incoming requests counter

func IncrementPublish ¶

func IncrementPublish(desc, status string)

IncrementPublish increments the publish counter

func IncrementWayback ¶

func IncrementWayback(from, status string)

IncrementWayback increments the incoming requests counter

Types ¶

type Collector ¶

type Collector struct {
	// WaybackPgs reports the archiving result for configured services
	WaybackPgs prometheus.GaugeVec

	// PlaybackPgs reports the playback result for configured services
	PlaybackPgs prometheus.GaugeVec

	// PublishPgs reports the publish result for configured services
	PublishPgs prometheus.GaugeVec
	// contains filtered or unexported fields
}

Collector represents a metric collector.

var Gather *Collector

Gather holds configured collector.

func NewCollector ¶

func NewCollector() *Collector

NewCollector initializes a new metric collector.

func (*Collector) Collect ¶

func (c *Collector) Collect(ch chan<- prometheus.Metric)

Collect sends all the collected metrics to the provided prometheus channel. It requires the caller to handle synchronization.

func (*Collector) Describe ¶

func (c *Collector) Describe(ch chan<- *prometheus.Desc)

Describe sends the descriptors of each Collector related metrics we have defined to the provided prometheus channel.

func (*Collector) Export ¶

func (c *Collector) Export(labels ...string) string

Export export metrics by the given labels for matching.

Source Files ¶

View all Source files

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