add query expressions management by prom-adapter-config #560

saikey0379 · 2022-09-17T15:39:22Z

What type of PR is this?

Add support for automatic rendering of query expressions
More user-friendly query expressions management capabilities
Add support for extension-labels

Examples

Make sure you include metrics in your prometheus-adapter-config file

externalRules:
- seriesQuery: 'connection_count'
  metricsQuery: 'sum(<<.Series>>{<<.LabelMatchers>>})'
  resources:
    namespaced: false
  name:
    matches: "^(.*)_count"
    as: "${1}_per_second"

Add args

    command:
    - /craned
    args:
    ...
    - --prometheus-adapter-configmap=crane-system/prometheus-adapter-config/config.yaml
    #- --prometheus-adapter-config=/etc/adapter/config.yaml

Modify ehpa config

Delete annotation for metric-query "metric-query.autoscaling.crane.io: xxx"

Add metric config

  metrics:
  - external:
      metric:
        name: connection_per_second
        selector:
          matchLabels:
            pod_namespace: "default"
            pod_project: "test"
      target:
        averageValue: "30"
        type: AverageValue
    type: External

Test

# kubectl get tsp test -o yaml | grep expression
    expressionQuery:
      expression: sum(connection_count{pod_namespace="default",pod_project="test"})

Extension-labels

Add annotation for extension-labels

apiVersion: autoscaling.crane.io/v1alpha1
kind: EffectiveHorizontalPodAutoscaler
metadata:
  name: test
  namespace: default
  annotations:
    prom-adapter.autoscaling.crane.io/extension-labels: |
      [{"cluster":"prod"}]

Test

# kubectl get tsp test -o yaml | grep expression
    expressionQuery:
      expression: sum(connection_count{cluster="prod",pod_namespace="default",pod_project="test"})

github-actions · 2022-09-17T16:25:25Z

🎉 Successfully Build Images.
Now Support ARM Platforms.
Comment Post Time: 2022-12-13 15:18
Git Version: 4a9c9c7

Docker Registry

Overview: https://hub.docker.com/u/gocrane

Image	Pull Command
crane-agent:pr-560-4a9c9c7	docker pull gocrane/crane-agent:pr-560-4a9c9c7
dashboard:pr-560-4a9c9c7	docker pull gocrane/dashboard:pr-560-4a9c9c7
metric-adapter:pr-560-4a9c9c7	docker pull gocrane/metric-adapter:pr-560-4a9c9c7
craned:pr-560-4a9c9c7	docker pull gocrane/craned:pr-560-4a9c9c7

Quick Deploy - Helm

helm repo add crane https://finops-helm.pkg.coding.net/gocrane/gocrane
helm install crane -n crane-system --create-namespace \
                   --set craned.image.repository=gocrane/craned \
                   --set craned.image.tag=pr-560-4a9c9c7 \
                   --set metricAdapter.image.repository=gocrane/metric-adapter \
                   --set metricAdapter.image.tag=pr-560-4a9c9c7 \
                   --set craneAgent.image.repository=gocrane/crane-agent \
                   --set craneAgent.image.tag=pr-560-4a9c9c7 \
                   --set cranedDashboard.image.repository=gocrane/dashboard \
                   --set cranedDashboard.image.tag=pr-560-4a9c9c7 crane/crane

Coding Registry

Overview: https://finops.coding.net/public-artifacts/gocrane/crane/packages

Image	Pull Command
crane-agent:pr-560-4a9c9c7	docker pull finops-docker.pkg.coding.net/gocrane/crane/crane-agent:pr-560-4a9c9c7
dashboard:pr-560-4a9c9c7	docker pull finops-docker.pkg.coding.net/gocrane/crane/dashboard:pr-560-4a9c9c7
metric-adapter:pr-560-4a9c9c7	docker pull finops-docker.pkg.coding.net/gocrane/crane/metric-adapter:pr-560-4a9c9c7
craned:pr-560-4a9c9c7	docker pull finops-docker.pkg.coding.net/gocrane/crane/craned:pr-560-4a9c9c7

Quick Deploy - Helm

helm repo add crane https://finops-helm.pkg.coding.net/gocrane/gocrane
helm install crane -n crane-system --create-namespace \
                   --set craned.image.repository=finops-docker.pkg.coding.net/gocrane/crane/craned \
                   --set craned.image.tag=pr-560-4a9c9c7 \
                   --set metricAdapter.image.repository=finops-docker.pkg.coding.net/gocrane/crane/metric-adapter \
                   --set metricAdapter.image.tag=pr-560-4a9c9c7 \
                   --set craneAgent.image.repository=finops-docker.pkg.coding.net/gocrane/crane/crane-agent \
                   --set craneAgent.image.tag=pr-560-4a9c9c7 \
                   --set cranedDashboard.image.repository=finops-docker.pkg.coding.net/gocrane/crane/dashboard \
                   --set cranedDashboard.image.tag=pr-560-4a9c9c7 crane/crane

Ghcr Registry

Overview: https://github.com/orgs/gocrane/packages?repo_name=crane

Image	Pull Command
crane-agent:pr-560-4a9c9c7	docker pull ghcr.io/gocrane/crane/crane-agent:pr-560-4a9c9c7
dashboard:pr-560-4a9c9c7	docker pull ghcr.io/gocrane/crane/dashboard:pr-560-4a9c9c7
metric-adapter:pr-560-4a9c9c7	docker pull ghcr.io/gocrane/crane/metric-adapter:pr-560-4a9c9c7
craned:pr-560-4a9c9c7	docker pull ghcr.io/gocrane/crane/craned:pr-560-4a9c9c7

Quick Deploy - Helm

helm repo add crane https://finops-helm.pkg.coding.net/gocrane/gocrane
helm install crane -n crane-system --create-namespace \
                   --set craned.image.repository=ghcr.io/gocrane/crane/craned \
                   --set craned.image.tag=pr-560-4a9c9c7 \
                   --set metricAdapter.image.repository=ghcr.io/gocrane/crane/metric-adapter \
                   --set metricAdapter.image.tag=pr-560-4a9c9c7 \
                   --set craneAgent.image.repository=ghcr.io/gocrane/crane/crane-agent \
                   --set craneAgent.image.tag=pr-560-4a9c9c7 \
                   --set cranedDashboard.image.repository=ghcr.io/gocrane/crane/dashboard \
                   --set cranedDashboard.image.tag=pr-560-4a9c9c7 crane/crane

github-actions · 2022-09-30T02:25:30Z

🎊 PR Preview c177e23 has been successfully built and deployed to https://gocrane-crane-preview-pr-560.surge.sh

🕐 Build time: 0.011s

_{🤖 By surge-preview}

qmhu · 2022-12-05T14:26:17Z

go.mod

@@ -12,7 +12,7 @@ require (
 	github.com/prometheus/client_golang v1.11.0
 	github.com/prometheus/common v0.26.0
 	github.com/shirou/gopsutil v3.21.10+incompatible
-	github.com/spf13/cobra v1.1.3
+	github.com/spf13/cobra v1.2.1


Is this necessary？

qmhu · 2022-12-05T14:32:46Z

pkg/utils/util.go

@@ -91,3 +97,18 @@ func CmpFloat(p1, p2 float64) int32 {
 	}
 	return 1
 }
+
+func GetFileMd5(file string) (string, error) {


use fsnotify to implement it.

please refer to:
https://github.com/gocrane/crane/blob/main/pkg/recommendation/manager.go#L78

qmhu · 2022-12-05T14:40:32Z

pkg/utils/expression_prom_default.go

+	PostRegMatchesPodStatefulset = `[0-9]+$`
+)
+
+func GetPodNameReg(resourceName string, resourceType string) string {


Please add a Unit test for it

qmhu · 2022-12-05T14:41:01Z

pkg/utils/expression_prom_adapter.go

+
+// define MetricRule for expressionQuery, SeriesName for original metric name, MetricName for name converted by prometheus-adapter
+
+type MetricRule struct {


suggest to move it to another path

qmhu · 2022-12-05T14:46:02Z

pkg/controller/ehpa/prom_adapter_configmap_controller.go

+)
+
+// controller for configMap of prometheus-adapter
+type PromAdapterConfigMapController struct {


Normally a controller should be independency. So i suggest you can implement it referring to OOMRecorder's implementation.

qmhu · 2022-12-05T14:47:04Z

pkg/controller/ehpa/effective_hpa_controller.go

+	ScaleClient         scale.ScalesGetter
+	K8SVersion          *version.Version
+	Config              EhpaControllerConfig
+	MetricRulesResource []utils.MetricRule


Better to manage rules in a in depended class .

code refine

qmhu

LGTM

Please fix the lints

qmhu · 2022-12-07T14:09:31Z

cmd/craned/app/manager.go

+		}
+
+		if opts.DataSourcePromConfig.AdapterConfigMap != "" {
+			// PrometheusAdapterConfigFetcher


if opts.DataSourcePromConfig.AdapterConfigMap != "" || opts.DataSourcePromConfig.AdapterConfig != "" {
init()
}

github-actions bot added the area:autoscaling label Sep 17, 2022

github-actions bot added deploy documentation Improvements or additions to documentation workflows labels Sep 30, 2022

github-actions bot removed deploy documentation Improvements or additions to documentation workflows labels Sep 30, 2022

saikey0379 force-pushed the main branch from 26b4fc9 to 57761f6 Compare October 17, 2022 05:48

github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Oct 17, 2022

saikey0379 and others added 13 commits December 2, 2022 13:52

add support for prom-adapter-config

24f5f89

configmap load and gofmt

632cfb9

errcheck

ec5d5ad

support prom-adapter regexp

75a64ce

effiective MetricMatches

71e982b

lint

490bf5f

resourceMetrics reg matches

d78ecb4

merge

2c10ed3

merge

a8b3f77

merge

f1535dd

gofmt

a88b0c5

reduce coupling and undelete tsp

122138d

rebase

52cfc8c

saikey0379 force-pushed the main branch from 8dd4418 to 52cfc8c Compare December 2, 2022 06:20

container not nil

61842bd

qmhu reviewed Dec 5, 2022

View reviewed changes

ying.ding added 2 commits December 7, 2022 15:37

prometheus-adapter-config-fetcher

b8cb20c

prometheus-adapter-config-fetcher

f6ba1df

ying.ding and others added 13 commits December 7, 2022 15:48

prometheus-adapter-config-fetcher

31e70b0

prometheus-adapter fix

b5847fa

import and unit test

933ebd7

golint

9998388

load err for labelMatcher sort

18caf24

add configmap flags

9b6be3f

golint

cfcf7c4

rm extension-labels

1edd060

code refine

e6ea343

fix parsingRules

22d3d68

Merge pull request #3 from saikey0379/saikey-main

8dfc96c

code refine

merge

2322c33

ut

8dd1fe0

qmhu approved these changes Dec 13, 2022

View reviewed changes

ying.ding added 3 commits December 13, 2022 14:37

lint

f819756

MetricMatches for Prometheus-adapter-config

98d1e99

gofmt

4a9c9c7

qmhu merged commit a4088c7 into gocrane:main Dec 13, 2022

qmhu linked an issue Dec 14, 2022 that may be closed by this pull request

QOS recommendations for multi-cluster prometheus summary metrics #628

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add query expressions management by prom-adapter-config #560

add query expressions management by prom-adapter-config #560

saikey0379 commented Sep 17, 2022 •

edited

Loading

github-actions bot commented Sep 17, 2022 •

edited

Loading

github-actions bot commented Sep 30, 2022 •

edited

Loading

qmhu Dec 5, 2022

qmhu Dec 5, 2022

qmhu Dec 5, 2022

qmhu Dec 5, 2022

qmhu Dec 5, 2022

qmhu Dec 5, 2022

qmhu left a comment

qmhu Dec 7, 2022


		// define MetricRule for expressionQuery, SeriesName for original metric name, MetricName for name converted by prometheus-adapter

		type MetricRule struct {

add query expressions management by prom-adapter-config #560

add query expressions management by prom-adapter-config #560

Conversation

saikey0379 commented Sep 17, 2022 • edited Loading

What type of PR is this?

Examples

Make sure you include metrics in your prometheus-adapter-config file

Add args

Modify ehpa config

Delete annotation for metric-query "metric-query.autoscaling.crane.io: xxx"

Add metric config

Test

Extension-labels

Add annotation for extension-labels

Test

github-actions bot commented Sep 17, 2022 • edited Loading

Docker Registry

Coding Registry

Ghcr Registry

github-actions bot commented Sep 30, 2022 • edited Loading

qmhu Dec 5, 2022

Choose a reason for hiding this comment

qmhu Dec 5, 2022

Choose a reason for hiding this comment

qmhu Dec 5, 2022

Choose a reason for hiding this comment

qmhu Dec 5, 2022

Choose a reason for hiding this comment

qmhu Dec 5, 2022

Choose a reason for hiding this comment

qmhu Dec 5, 2022

Choose a reason for hiding this comment

qmhu left a comment

Choose a reason for hiding this comment

qmhu Dec 7, 2022

Choose a reason for hiding this comment

saikey0379 commented Sep 17, 2022 •

edited

Loading

github-actions bot commented Sep 17, 2022 •

edited

Loading

github-actions bot commented Sep 30, 2022 •

edited

Loading