Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Override and pass in additional grafana agent config keys #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 13, 2022
Merged

Override and pass in additional grafana agent config keys #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions lib/prom_ex/config.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,8 @@ defmodule PromEx.Config do

* `:template_file` - The full path to the template used to render the agent config file.

* all of these keys, and any additional ones, will be provided as EEx vars to the template file.

* `:metrics_server` - This key contains the configuration information needed to run a standalone
HTTP server powered by Cowboy. This server provides a lightweight solution to serving up PromEx
metrics. Its configuration options are:
Expand Down Expand Up @@ -325,21 +327,22 @@ defmodule PromEx.Config do

defp extract_opts_for_config(opts) do
%{
scrape_interval: Keyword.get(opts, :scrape_interval, "15s"),
bearer_token: Keyword.get(opts, :bearer_token, "blank"),
log_level: Keyword.get(opts, :log_level, "error"),
agent_port: Keyword.get(opts, :agent_port, "4040"),
grpc_port: Keyword.get(opts, :grpc_port, "9095"),
job: Keyword.get(opts, :job, nil),
instance: Keyword.get(opts, :instance, nil),
scrape_interval: "15s",
bearer_token: "blank",
log_level: "error",
agent_port: "4040",
grpc_port: "9095",
job: nil,
instance: nil,
prometheus_url: get_grafana_agent_config(opts, :prometheus_url),
prometheus_username: get_grafana_agent_config(opts, :prometheus_username),
prometheus_password: get_grafana_agent_config(opts, :prometheus_password),
metrics_server_path: Keyword.get(opts, :metrics_server_path, "/metrics"),
metrics_server_port: Keyword.get(opts, :metrics_server_port, 4000),
metrics_server_host: Keyword.get(opts, :metrics_server_host, "localhost"),
metrics_server_scheme: Keyword.get(opts, :metrics_server_scheme, :https)
metrics_server_path: "/metrics",
metrics_server_port: 4000,
metrics_server_host: "localhost",
metrics_server_scheme: :https
}
|> Map.merge(Map.new(opts))
end

defp get_grafana_agent_config(grafana_agent_opts, config_key) do
Expand Down
71 changes: 71 additions & 0 deletions test/prom_ex/config_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,77 @@ defmodule PromEx.ConfigTest do
} = config
end

test "should generate default grafana agent config" do
config =
Config.build(
grafana_agent: [
config_opts: [
prometheus_url: "https://prometheus",
prometheus_username: "prometheus-user",
prometheus_password: "prometheus-password"
]
]
)

assert %PromEx.Config{
grafana_agent_config: %{
config_opts: %{
prometheus_url: "https://prometheus",
prometheus_username: "prometheus-user",
prometheus_password: "prometheus-password",
scrape_interval: "15s",
bearer_token: "blank",
log_level: "error",
agent_port: "4040",
grpc_port: "9095",
job: nil,
instance: nil,
metrics_server_path: "/metrics",
metrics_server_port: 4000,
metrics_server_host: "localhost",
metrics_server_scheme: :https
}
}
} = config
end

test "should override existing keys, and pass additional keys to grafana agent config" do
config =
Config.build(
grafana_agent: [
config_opts: [
prometheus_url: "https://prometheus",
prometheus_username: "prometheus-user",
prometheus_password: "prometheus-password",
agent_port: "4141",
template_file: "path/to/template",
foo: "bar"
]
]
)

assert %PromEx.Config{
grafana_agent_config: %{
config_opts: %{
# required
prometheus_url: "https://prometheus",
prometheus_username: "prometheus-user",
prometheus_password: "prometheus-password",

# default
scrape_interval: "15s",

# override
agent_port: "4141",

# new keys
template_file: "path/to/template",
foo: "bar"
}
}
} = config
end

test "should raise an error if there are missing standalone metrics server fields" do
assert_raise RuntimeError, "When configuring the PromEx metrics server, the :port key is required.", fn ->
Config.build(metrics_server: [])
Expand Down