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@d738a711382b5b3d8f5406bfea0c13bf6c9e81ce

Entrypoint

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

firingAlerts() 🔗

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

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

targets() 🔗

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

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

rules() 🔗

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

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