risedev/config_gen/
grafana_gen.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::path::Path;
16
17use anyhow::{Result, anyhow};
18
19use crate::GrafanaConfig;
20pub struct GrafanaGen;
21
22impl GrafanaGen {
23    pub fn gen_custom_ini(&self, config: &GrafanaConfig) -> String {
24        let grafana_host = &config.listen_address;
25        let grafana_port = config.port;
26
27        format!(
28            r#"# --- THIS FILE IS AUTO GENERATED BY RISEDEV ---
29[server]
30http_addr = {grafana_host}
31http_port = {grafana_port}
32grpc-max-recv-msg-size-bytes = 104857600 # 100 Mb
33grpc-max-send-msg-size-bytes = 104857600 # 100 Mb
34
35[users]
36default_theme = light
37
38[feature_toggles]
39enable = traceToMetrics
40
41[auth.anonymous]
42enabled = true
43org_role = Admin
44    "#
45        )
46    }
47
48    /// `risedev-prometheus.yml`
49    pub fn gen_prometheus_datasource_yml(&self, config: &GrafanaConfig) -> Result<String> {
50        let provide_prometheus = config.provide_prometheus.as_ref().unwrap();
51        if provide_prometheus.len() != 1 {
52            return Err(anyhow!(
53                "expect 1 prometheus node, found {}",
54                provide_prometheus.len()
55            ));
56        }
57        let prometheus = &provide_prometheus[0];
58        let prometheus_host = &prometheus.address;
59        let prometheus_port = &prometheus.port;
60
61        let yml = format!(
62            r#"# --- THIS FILE IS AUTO GENERATED BY RISEDEV ---
63apiVersion: 1
64deleteDatasources:
65  - name: risedev-prometheus
66datasources:
67  - name: risedev-prometheus
68    type: prometheus
69    access: proxy
70    url: http://{prometheus_host}:{prometheus_port}
71    withCredentials: false
72    isDefault: true
73    tlsAuth: false
74    tlsAuthWithCACert: false
75    version: 1
76    editable: true
77    "#,
78        );
79        Ok(yml)
80    }
81
82    /// `risedev-tempo.yml`
83    pub fn gen_tempo_datasource_yml(&self, config: &GrafanaConfig) -> Result<String> {
84        let provide_tempo = config.provide_tempo.as_ref().unwrap();
85        if provide_tempo.len() != 1 {
86            return Err(anyhow!(
87                "expect 1 tempo node, found {}",
88                provide_tempo.len()
89            ));
90        }
91        let tempo = &provide_tempo[0];
92        let tempo_host = &tempo.address;
93        let tempo_port = &tempo.port;
94
95        let yml = format!(
96            r#"# --- THIS FILE IS AUTO GENERATED BY RISEDEV ---
97apiVersion: 1
98deleteDatasources:
99  - name: risedev-tempo
100datasources:
101  - name: risedev-tempo
102    type: tempo
103    url: http://{tempo_host}:{tempo_port}
104    jsonData:
105      spanBar:
106        type: None
107    editable: true
108    "#,
109        );
110        Ok(yml)
111    }
112
113    /// `grafana-risedev-dashboard.yml`
114    pub fn gen_dashboard_yml(
115        &self,
116        config: &GrafanaConfig,
117        generate_path: impl AsRef<Path>,
118        grafana_read_path: impl AsRef<Path>,
119    ) -> Result<String> {
120        let provide_prometheus = config.provide_prometheus.as_ref().unwrap();
121        if provide_prometheus.len() != 1 {
122            return Err(anyhow!(
123                "expect 1 prometheus node, found {}",
124                provide_prometheus.len()
125            ));
126        };
127
128        let filenames = [
129            "risingwave-user-dashboard.json",
130            "risingwave-dev-dashboard.json",
131            "risingwave-traces.json", // TODO: generate this
132        ];
133        let generate_path = generate_path.as_ref();
134        for filename in filenames {
135            let from = Path::new("grafana").join(filename);
136            let to = Path::new(generate_path).join(filename);
137            std::fs::copy(from, to)?;
138        }
139        let grafana_read_path = grafana_read_path.as_ref();
140        let dashboard_path_str = grafana_read_path
141            .to_str()
142            .ok_or_else(|| anyhow!("invalid string"))?;
143
144        let yml = format!(
145            r#"# --- THIS FILE IS AUTO GENERATED BY RISEDEV ---
146apiVersion: 1
147
148providers:
149  - name: 'risingwave-grafana'
150    orgId: 1
151    folder: ''
152    folderUid: ''
153    type: file
154    disableDeletion: false
155    updateIntervalSeconds: 1
156    allowUiUpdates: true
157    options:
158      path: {dashboard_path_str}
159      foldersFromFilesStructure: false
160    "#,
161        );
162        Ok(yml)
163    }
164
165    pub fn gen_s3_dashboard_yml(
166        &self,
167        config: &GrafanaConfig,
168        prefix_config: impl AsRef<Path>,
169    ) -> Result<String> {
170        let provide_prometheus = config.provide_prometheus.as_ref().unwrap();
171        if provide_prometheus.len() != 1 {
172            return Err(anyhow!(
173                "expect 1 prometheus node, found {}",
174                provide_prometheus.len()
175            ));
176        };
177
178        let prefix_config = prefix_config.as_ref();
179        let s3_dashboard_path = Path::new(&prefix_config)
180            .join("aws-s3.json")
181            .to_string_lossy()
182            .to_string();
183        let yml = format!(
184            r#"# --- THIS FILE IS AUTO GENERATED BY RISEDEV ---
185apiVersion: 1
186
187providers:
188  - name: 's3-grafana'
189    orgId: 1
190    folder: ''
191    folderUid: ''
192    type: file
193    disableDeletion: false
194    updateIntervalSeconds: 60
195    allowUiUpdates: true
196    options:
197      path: {s3_dashboard_path}
198      foldersFromFilesStructure: false
199    "#,
200        );
201        Ok(yml)
202    }
203}
risedev/config_gen/grafana_gen.rs

risedev/config_gen/
grafana_gen.rs
