-
Notifications
You must be signed in to change notification settings - Fork 501
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add annotations for Prometheus (#6037)
- Loading branch information
1 parent
d0fa980
commit bb7a088
Showing
6 changed files
with
86 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
// Copyright 2024 PingCAP, Inc. | ||
// | ||
// 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 k8s | ||
|
||
import "fmt" | ||
|
||
// AnnoProm returns the prometheus annotations for a pod. | ||
func AnnoProm(port int32, path string) map[string]string { | ||
return map[string]string{ | ||
"prometheus.io/scrape": "true", | ||
"prometheus.io/port": fmt.Sprintf("%d", port), | ||
"prometheus.io/path": path, | ||
} | ||
} | ||
|
||
// AnnoAdditionalProm returns the additional prometheus annotations for a pod. | ||
// Some pods may have multiple prometheus endpoints. | ||
// We assume the same path is used for all endpoints. | ||
func AnnoAdditionalProm(name string, port int32) map[string]string { | ||
return map[string]string{ | ||
fmt.Sprintf("%s.prometheus.io/port", name): fmt.Sprintf("%d", port), | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
// Copyright 2024 PingCAP, Inc. | ||
// | ||
// 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 k8s | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/stretchr/testify/require" | ||
) | ||
|
||
func TestPromAnno(t *testing.T) { | ||
anno := AnnoProm(8234, "/metrics") | ||
require.Equal(t, map[string]string{ | ||
"prometheus.io/scrape": "true", | ||
"prometheus.io/port": "8234", | ||
"prometheus.io/path": "/metrics", | ||
}, anno) | ||
|
||
annoAdditional := AnnoAdditionalProm("tiflash.proxy", 20292) | ||
require.Equal(t, map[string]string{ | ||
"tiflash.proxy.prometheus.io/port": "20292", | ||
}, annoAdditional) | ||
} |