diff --git a/cmd/tetra/commands_linux.go b/cmd/tetra/commands_linux.go index c50f70d1f54..c7f242cc1a1 100644 --- a/cmd/tetra/commands_linux.go +++ b/cmd/tetra/commands_linux.go @@ -6,6 +6,7 @@ package main import ( "github.com/cilium/tetragon/cmd/tetra/bugtool" "github.com/cilium/tetragon/cmd/tetra/dump" + "github.com/cilium/tetragon/cmd/tetra/metrics" "github.com/cilium/tetragon/cmd/tetra/policyfilter" "github.com/cilium/tetragon/cmd/tetra/probe" "github.com/cilium/tetragon/cmd/tetra/tracingpolicy" @@ -19,4 +20,5 @@ func addCommands(rootCmd *cobra.Command) { rootCmd.AddCommand(dump.New()) rootCmd.AddCommand(policyfilter.New()) rootCmd.AddCommand(probe.New()) + rootCmd.AddCommand(metrics.New()) } diff --git a/cmd/tetra/metrics/print.go b/cmd/tetra/metrics/print.go new file mode 100644 index 00000000000..acc2a910df3 --- /dev/null +++ b/cmd/tetra/metrics/print.go @@ -0,0 +1,62 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Authors of Tetragon + +package metrics + +import ( + "log/slog" + + "github.com/isovalent/metricstool/pkg/metricsmd" + "github.com/prometheus/client_golang/prometheus" + "github.com/spf13/cobra" + + "github.com/cilium/tetragon/pkg/metrics/metricsconfig" +) + +func New() *cobra.Command { + targets := map[string]string{ + "tetragon": "Tetragon", + } + + overrides := []metricsmd.LabelOverrides{ + // Theses metrics takes VCS info into account supplied at build + // time, which changes every build, so override those. + { + Metric: "go_info", + Overrides: []metricsmd.LabelValues{ + { + Label: "version", + Values: []string{"go1.22.0"}, + }, + }, + }, + { + Metric: "tetragon_build_info", + Overrides: []metricsmd.LabelValues{ + { + Label: "commit", + Values: []string{"931b70f2c9878ba985ba6b589827bea17da6ec33"}, + }, + { + Label: "go_version", + Values: []string{"go1.22.0"}, + }, + { + Label: "modified", + Values: []string{"false"}, + }, + { + Label: "time", + Values: []string{"2022-05-13T15:54:45Z"}, + }, + }, + }, + } + + return metricsmd.NewCmd(nil, nil, map[string]string{}, targets, overrides, initMetrics) +} + +func initMetrics(_ string, reg *prometheus.Registry, _ *slog.Logger) error { + metricsconfig.InitAllMetrics(reg) + return nil +} diff --git a/go.mod b/go.mod index 16978630c88..dd807f6957a 100644 --- a/go.mod +++ b/go.mod @@ -23,6 +23,7 @@ require ( github.com/grpc-ecosystem/go-grpc-middleware/providers/prometheus v1.0.0 github.com/hashicorp/golang-lru/v2 v2.0.7 github.com/iancoleman/strcase v0.3.0 + github.com/isovalent/metricstool v0.0.0-20240220124724-285815580016 github.com/jpillora/longestcommon v0.0.0-20161227235612-adb9d91ee629 github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 github.com/mennanov/fieldmask-utils v1.1.0 diff --git a/go.sum b/go.sum index 4908571bc00..542380a7ddf 100644 --- a/go.sum +++ b/go.sum @@ -335,6 +335,8 @@ github.com/imdario/mergo v0.3.16 h1:wwQJbIsHYGMUyLSPrEq1CT16AhnhNJQ51+4fdHUnCl4= github.com/imdario/mergo v0.3.16/go.mod h1:WBLT9ZmE3lPoWsEzCh9LPo3TiwVN+ZKEjmz+hD27ysY= github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= +github.com/isovalent/metricstool v0.0.0-20240220124724-285815580016 h1:8kTfM4TIcCeKUfD0ct45SHLUgIqBB391be1HuyjaKVc= +github.com/isovalent/metricstool v0.0.0-20240220124724-285815580016/go.mod h1:ol80lPphlGYFS16mc54bPVudTT8GkIaHwRMiUuya0sY= github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY= diff --git a/vendor/github.com/isovalent/metricstool/LICENSE b/vendor/github.com/isovalent/metricstool/LICENSE new file mode 100644 index 00000000000..261eeb9e9f8 --- /dev/null +++ b/vendor/github.com/isovalent/metricstool/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/vendor/github.com/isovalent/metricstool/pkg/metricsmd/generate.go b/vendor/github.com/isovalent/metricstool/pkg/metricsmd/generate.go new file mode 100644 index 00000000000..48573c1e9c6 --- /dev/null +++ b/vendor/github.com/isovalent/metricstool/pkg/metricsmd/generate.go @@ -0,0 +1,103 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright 2024 Isovalent Inc. + +package metricsmd + +import ( + "fmt" + "io" + "sort" + "strings" + + "github.com/prometheus/client_golang/prometheus" +) + +// Generate +func Generate(reg *prometheus.Registry, w io.Writer, labelOverrides []LabelOverrides) error { + metricsFamilies, err := reg.Gather() + if err != nil { + return err + } + sort.Slice(metricsFamilies, func(i, j int) bool { + return metricsFamilies[i].GetName() < metricsFamilies[j].GetName() + }) + + for _, metric := range metricsFamilies { + // Include the metric name and help text. + io.WriteString(w, fmt.Sprintf("## `%s`\n\n", metric.GetName())) + io.WriteString(w, fmt.Sprintf("%s\n\n", metric.GetHelp())) + // The rest is generating a list of label names and values + + // map of "label_name" -> set([label_values...]) + labelsToValues := make(map[string]map[string]struct{}) + + // Iterate over the series + series := metric.GetMetric() + for _, m := range series { + for _, label := range m.GetLabel() { + // Check if the map entry exists + _, ok := labelsToValues[label.GetName()] + if !ok { + // Initialize it + labelsToValues[label.GetName()] = make(map[string]struct{}) + } + // Add the value to the set of values for this label + labelsToValues[label.GetName()][label.GetValue()] = struct{}{} + } + } + + // Support overriding the values of labels, in case they're not suitable for docs. + for _, override := range labelOverrides { + if override.Metric != metric.GetName() { + continue + } + for _, o := range override.Overrides { + // Erase the current labels if any exist + labelsToValues[o.Label] = make(map[string]struct{}) + for _, overrideVal := range o.Values { + labelsToValues[o.Label][overrideVal] = struct{}{} + } + } + } + + // Generate a list of labels and their values + var finalLabels []LabelValues + for label, valuesMap := range labelsToValues { + var vals []string + for val := range valuesMap { + vals = append(vals, val) + } + // Sort the values + sort.Strings(vals) + finalLabels = append(finalLabels, LabelValues{ + Label: label, + Values: vals, + }) + } + + // Write out the labels out if there are any + if len(finalLabels) > 0 { + sort.Slice(finalLabels, func(i, j int) bool { + return finalLabels[i].Label < finalLabels[j].Label + }) + io.WriteString(w, "| label | values |\n") + io.WriteString(w, "| ----- | ------ |\n") + for _, labelVal := range finalLabels { + row := fmt.Sprintf("| `%-5s` | `%5s` |\n", labelVal.Label, strings.Join(labelVal.Values, ", ")) + io.WriteString(w, row) + } + io.WriteString(w, "\n") + } + } + return nil +} + +type LabelValues struct { + Label string + Values []string +} + +type LabelOverrides struct { + Metric string + Overrides []LabelValues +} diff --git a/vendor/github.com/isovalent/metricstool/pkg/metricsmd/print.go b/vendor/github.com/isovalent/metricstool/pkg/metricsmd/print.go new file mode 100644 index 00000000000..c614e8b3c3e --- /dev/null +++ b/vendor/github.com/isovalent/metricstool/pkg/metricsmd/print.go @@ -0,0 +1,69 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright 2024 Isovalent Inc. + +package metricsmd + +import ( + "bytes" + "fmt" + "io" + "log/slog" + + "golang.org/x/exp/maps" + + "github.com/prometheus/client_golang/prometheus" + "github.com/spf13/cobra" + "github.com/spf13/viper" +) + +type targetToHeader map[string]string + +type initMetricsFunc func(target string, reg *prometheus.Registry, log *slog.Logger) error + +// NewCmd creates a Cobra command for generating metrics reference docs. +// It's intended to be used as an add-on to applications that have a Cobra CLI +// and expose Prometheus metrics. +func NewCmd(vp *viper.Viper, log *slog.Logger, annotations map[string]string, + targets targetToHeader, overrides []LabelOverrides, initMetrics initMetricsFunc, +) *cobra.Command { + cmd := &cobra.Command{ + Use: "metrics-docs", + Hidden: true, + Annotations: annotations, + ValidArgs: maps.Keys(targets), + Args: cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs), + PreRunE: func(cmd *cobra.Command, _ []string) error { + if vp != nil { + flags := cmd.Flags() + if err := vp.BindPFlags(flags); err != nil { + return err + } + } + return nil + }, + RunE: func(cmd *cobra.Command, args []string) error { + target := args[0] + reg := prometheus.NewRegistry() + + err := initMetrics(target, reg, log) + if err != nil { + return err + } + + var b bytes.Buffer + // Comment to inform people this file is autogenerated. + b.WriteString("\n\n") + // Document title + b.WriteString(fmt.Sprintf("# %s Metrics\n\n", targets[target])) + // Generate metrics reference + err = Generate(reg, &b, overrides) + if err != nil { + return err + } + io.Copy(cmd.OutOrStdout(), &b) + + return nil + }, + } + return cmd +} diff --git a/vendor/modules.txt b/vendor/modules.txt index 59c2f7a7699..d7ca0109e0f 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -579,6 +579,9 @@ github.com/imdario/mergo # github.com/inconshreveable/mousetrap v1.1.0 ## explicit; go 1.18 github.com/inconshreveable/mousetrap +# github.com/isovalent/metricstool v0.0.0-20240220124724-285815580016 +## explicit; go 1.22.0 +github.com/isovalent/metricstool/pkg/metricsmd # github.com/josharian/intern v1.0.0 ## explicit; go 1.5 github.com/josharian/intern