Dagger
Search

prometheus

This module has been generated via dagger init and serves as a reference to
basic module structure as you get started with Dagger.

Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.

The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.

Installation

dagger install github.com/EladAviczer/daggerverse/prometheus@dcd1489ab11edae9e958154e34497d31eb2b6b94

Entrypoint

Return Type
Prometheus !
Arguments
NameTypeDefault ValueDescription
serverString !-prometheus server URL
Example
dagger -m github.com/EladAviczer/daggerverse/prometheus@dcd1489ab11edae9e958154e34497d31eb2b6b94 call \
 --server string
func (m *MyModule) Example(server string) *dagger.Prometheus  {
	return dag.
			Prometheus(server)
}
@function
def example(server: str) -> dagger.Prometheus:
	return (
		dag.prometheus(server)
	)
@func()
example(server: string): Prometheus {
	return dag
		.prometheus(server)
}

Types

Prometheus 🔗

promQl() 🔗

PromQl runs an instant PromQL query via /api/v1/query (JSON output).

Return Type
String !
Arguments
NameTypeDefault ValueDescription
promQueryString !-query in PromQL format
bearerSecret -No description provided
Example
dagger -m github.com/EladAviczer/daggerverse/prometheus@dcd1489ab11edae9e958154e34497d31eb2b6b94 call \
 --server string prom-ql --prom-query string
func (m *MyModule) Example(ctx context.Context, server string, promQuery string) string  {
	return dag.
			Prometheus(server).
			PromQl(ctx, promQuery)
}
@function
async def example(server: str, prom_query: str) -> str:
	return await (
		dag.prometheus(server)
		.prom_ql(prom_query)
	)
@func()
async example(server: string, promQuery: string): Promise<string> {
	return dag
		.prometheus(server)
		.promQl(promQuery)
}

firingAlerts() 🔗

FiringAlerts queries the /api/v1/alerts endpoint to list all firing alerts.

Return Type
String !
Arguments
NameTypeDefault ValueDescription
bearerSecret -No description provided
Example
dagger -m github.com/EladAviczer/daggerverse/prometheus@dcd1489ab11edae9e958154e34497d31eb2b6b94 call \
 --server string firing-alerts
func (m *MyModule) Example(ctx context.Context, server string) string  {
	return dag.
			Prometheus(server).
			FiringAlerts(ctx)
}
@function
async def example(server: str) -> str:
	return await (
		dag.prometheus(server)
		.firing_alerts()
	)
@func()
async example(server: string): Promise<string> {
	return dag
		.prometheus(server)
		.firingAlerts()
}

targets() 🔗

Targets queries the /api/v1/targets endpoint to list all targets.

Return Type
String !
Arguments
NameTypeDefault ValueDescription
bearerSecret -No description provided
Example
dagger -m github.com/EladAviczer/daggerverse/prometheus@dcd1489ab11edae9e958154e34497d31eb2b6b94 call \
 --server string targets
func (m *MyModule) Example(ctx context.Context, server string) string  {
	return dag.
			Prometheus(server).
			Targets(ctx)
}
@function
async def example(server: str) -> str:
	return await (
		dag.prometheus(server)
		.targets()
	)
@func()
async example(server: string): Promise<string> {
	return dag
		.prometheus(server)
		.targets()
}

rules() 🔗

Rules queries the /api/v1/rules endpoint to list all alerting and recording rules.

Return Type
String !
Arguments
NameTypeDefault ValueDescription
bearerSecret -No description provided
Example
dagger -m github.com/EladAviczer/daggerverse/prometheus@dcd1489ab11edae9e958154e34497d31eb2b6b94 call \
 --server string rules
func (m *MyModule) Example(ctx context.Context, server string) string  {
	return dag.
			Prometheus(server).
			Rules(ctx)
}
@function
async def example(server: str) -> str:
	return await (
		dag.prometheus(server)
		.rules()
	)
@func()
async example(server: string): Promise<string> {
	return dag
		.prometheus(server)
		.rules()
}