global

package
v0.0.0-...-421597d Latest Latest
Warning

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

Go to latest
Published: Mar 8, 2025 License: AGPL-3.0 Imports: 9 Imported by: 0

Documentation

Overview

Package global is used to set up a global mediocre_caddy_plugins App, which is primarily used for global options.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type App

type App struct {
	Metrics Metrics `json:"metrics"`
}

App describes all global configuration options of the top-level caddy.App provided by this module.

func (App) CaddyModule

func (App) CaddyModule() caddy.ModuleInfo

func (*App) Provision

func (a *App) Provision(ctx caddy.Context) error

func (*App) Start

func (a *App) Start() error

func (*App) Stop

func (a *App) Stop() error

func (*App) UnmarshalCaddyfile

func (a *App) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

type MetricHistogram

type MetricHistogram struct {
	Name    string    `json:"name"`
	Help    string    `json:"help"`
	Buckets []float64 `json:"buckets"`
	Labels  []string  `json:"labels"`
}

MetricHistogram describes a histogram metric which will be registered with Caddy's prometheus registry.

func (*MetricHistogram) UnmarshalCaddyfile

func (mh *MetricHistogram) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

type Metrics

type Metrics struct {
	Histograms []MetricHistogram `json:"histograms"`
	// contains filtered or unexported fields
}

Metrics describe all global metrics used within a running Caddy instance.

func (Metrics) HistogramByName

func (m Metrics) HistogramByName(name string) (*prometheus.HistogramVec, bool)

HistogramByName returns the prometheus histogram object configured with the given name.

func (*Metrics) UnmarshalCaddyfile

func (m *Metrics) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

Source Files

  • app.go
  • metrics.go

Jump to

Keyboard shortcuts

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