mirror of
https://github.com/kubesphere/kubekey.git
synced 2025-12-26 01:22:51 +00:00
145 lines
4.0 KiB
Go
145 lines
4.0 KiB
Go
/*
|
|
Copyright 2023 The KubeSphere Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package modules
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
|
|
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
|
|
|
|
"github.com/kubesphere/kubekey/v4/pkg/variable"
|
|
)
|
|
|
|
/*
|
|
The Prometheus module uses a dedicated Prometheus connector to query Prometheus data.
|
|
This module allows users to run PromQL queries against Prometheus servers defined in the inventory.
|
|
|
|
Configuration:
|
|
Users should define prometheus hosts in the inventory and specify connection information in the connector configuration:
|
|
|
|
prometheus:
|
|
connector:
|
|
type: prometheus
|
|
host: http://prometheus-server:9090 # The URL of the Prometheus server
|
|
username: admin # optional: basic auth username
|
|
password: password # optional: basic auth password
|
|
token: my-token # optional: Bearer token for authentication
|
|
timeout: 15s # optional: request timeout (default: 10s)
|
|
headers: # optional: custom HTTP headers
|
|
X-Custom-Header: custom-value
|
|
|
|
Usage Examples in Playbook Tasks:
|
|
1. Basic query:
|
|
```yaml
|
|
- name: Get Prometheus metrics
|
|
prometheus:
|
|
query: up
|
|
register: prometheus_result
|
|
```
|
|
|
|
2. Query with formatting options:
|
|
```yaml
|
|
- name: Get CPU idle time
|
|
prometheus:
|
|
query: sum(rate(node_cpu_seconds_total{mode='idle'}[5m]))
|
|
format: value
|
|
register: cpu_idle
|
|
```
|
|
|
|
3. Query with time parameter:
|
|
```yaml
|
|
- name: Get historical goroutines count
|
|
prometheus:
|
|
query: go_goroutines
|
|
time: 2023-01-01T12:00:00Z
|
|
register: goroutines
|
|
```
|
|
|
|
4. Get Prometheus server info:
|
|
```yaml
|
|
- name: Get Prometheus server information
|
|
prometheus:
|
|
info: true
|
|
register: prometheus_info
|
|
```
|
|
|
|
Format Options:
|
|
- raw: Return raw JSON response from Prometheus
|
|
- value: Extract single scalar/vector value (when possible)
|
|
- table: Format vector results as a table with metric, value, and timestamp columns
|
|
*/
|
|
|
|
// ModulePrometheus handles the "prometheus" module, using prometheus connector to execute PromQL queries
|
|
func ModulePrometheus(ctx context.Context, options ExecOptions) (string, string, error) {
|
|
// get host variable
|
|
ha, err := options.getAllVariables()
|
|
if err != nil {
|
|
return StdoutFailed, StderrGetHostVariable, err
|
|
}
|
|
|
|
// Get or create Prometheus connector
|
|
conn, err := options.getConnector(ctx)
|
|
if err != nil {
|
|
return StdoutFailed, "failed to get prometheus connector", err
|
|
}
|
|
defer conn.Close(ctx)
|
|
|
|
args := variable.Extension2Variables(options.Args)
|
|
|
|
// Get query parameters
|
|
query, err := variable.StringVar(ha, args, "query")
|
|
if err != nil {
|
|
return StdoutFailed, "failed to get prometheus query. Please provide a query parameter.", err
|
|
}
|
|
|
|
// Get optional parameters
|
|
format, _ := variable.StringVar(ha, args, "format")
|
|
timeParam, _ := variable.StringVar(ha, args, "time")
|
|
|
|
// Build command (include all parameters in JSON format)
|
|
cmdMap := map[string]string{
|
|
"query": query,
|
|
}
|
|
|
|
if format != "" {
|
|
cmdMap["format"] = format
|
|
}
|
|
|
|
if timeParam != "" {
|
|
cmdMap["time"] = timeParam
|
|
}
|
|
|
|
cmdBytes, err := json.Marshal(cmdMap)
|
|
if err != nil {
|
|
return StdoutFailed, "failed to marshal query params", err
|
|
}
|
|
|
|
// Execute query
|
|
result, _, err := conn.ExecuteCommand(ctx, string(cmdBytes))
|
|
if err != nil {
|
|
return StdoutFailed, "failed to execute prometheus query", err
|
|
}
|
|
|
|
return string(result), "", nil
|
|
}
|
|
|
|
func init() {
|
|
// Register prometheus module
|
|
utilruntime.Must(RegisterModule("prometheus", ModulePrometheus))
|
|
}
|