Doc: Tetragon metrics #1495

prateek041 · 2023-09-19T19:58:26Z

Closes #928

This PR:

Adds how to read tetragon metrics with Kubernetes and Package installation setup.

netlify · 2023-09-19T19:59:02Z

✅ Deploy Preview for tetragon ready!

Name	Link
🔨 Latest commit	`ee14431`
🔍 Latest deploy log	https://app.netlify.com/sites/tetragon/deploys/65130f45c5b10000080d7592
😎 Deploy Preview	https://deploy-preview-1495--tetragon.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

lambdanis · 2023-09-20T12:46:47Z

Thank you @prateek041 for this PR. Some high-level comments I have:

The intro is very friendly for people not proficient with Kubernetes, but I'm not sure if it belongs to the metrics page. I would rather add a "Validation" section to https://tetragon.cilium.io/docs/getting-started/deployment/kubernetes/, describing what to expect and how to check if Tetragon is running. Then the metrics page can just refer to the Kubernetes deployment page.
Can we use the tetragon service in this tutorial, instead of port-forwarding the pod directly? That is, kubectl -n kube-system port-forward service/tetragon 2112:2112. The port can also be checked by describing the service. In a tutorial for Kubernetes I think we should use the Kubernetes abstractions instead of interacting with containers directly.

prateek041 · 2023-09-20T14:35:35Z

Thank you @lambdanis for the review, making changes now.

tixxdz

LGTM, @prateek041 as long as it works let's please merge it

tixxdz · 2023-09-22T13:48:08Z

docs/content/en/docs/tutorials/tetragon-metrics.md

+
+Tetragon, when installed via release packages as mentioned in [Package Deployment](../getting-started/deployment/package.md). It can be interacted with `tetragon` command. By default, metrics are disabled, which can be enabled using `--metrics-server` flag, by specifying the address.
+


Hi @prateek041 please add that you can set the metrics address server by creating a file under /etc/tetragon/tetragon.conf.d/metrics-server with the address server as content, example localhost:2112

also please reference https://tetragon.cilium.io/docs/reference/tetragon-configuration/#configuration-examples for further examples

looking into it.

I added a section does this work ?

@tixxdz

docs/content/en/docs/tutorials/tetragon-metrics.md

tixxdz · 2023-09-22T13:54:57Z

Closes #928

This PR:

* Adds how to read tetragon metrics with different installation setup.

I guess this is done right?

Beside container stuff that should be contributed in another PR

* Explain Tetragon metrics

This is the part that is still missing right? can you do it in separate PR, please so we can merge this and have the metrics explained maybe in the reference? @jrfastab @michi-covalent wdyt reference for metrics is better?

tixxdz · 2023-09-22T13:55:35Z

You have one CI link failure I guess at the end you do package.md should be just package/ without .md

michi-covalent · 2023-09-22T14:46:28Z

This is the part that is still missing right? can you do it in separate PR, please so we can merge this and have the metrics explained maybe in the reference?

yeah let's do a separate PR

prateek041 · 2023-09-22T16:38:17Z

Let me make the suggested changes and push.

lambdanis

Looks good, thank you @prateek041 for the updates.

Explain Tetragon metrics
This is the part that is still missing right? can you do it in separate PR, please so we can merge this and have the metrics explained maybe in the reference?

Tetragon will have an autogenerated metrics reference soon™, so there is no need to explain metrics in this PR. Unless you have a specific idea what needs an extra explanation in addition to the reference?

docs/content/en/docs/tutorials/tetragon-metrics.md

mtardy

Thank you for taking the time to do this. Sorry if it looks overwhelming, I have many comments this time. Please tell me if you don't understand any and need clarification. :)

docs/content/en/docs/getting-started/deployment/kubernetes.md

docs/content/en/docs/tutorials/tetragon-metrics.md

mtardy · 2023-09-22T16:17:52Z

docs/content/en/docs/tutorials/tetragon-metrics.md

please can you wrap the lines at ~80 chars?

oh sorry for that, I had soft-wrap on, so it appeared Ok on my IDE. fixed that

docs/content/en/docs/tutorials/tetragon-metrics.md

mtardy · 2023-09-22T16:54:06Z

docs/content/en/docs/tutorials/tetragon-metrics.md

+### Fetch the Metrics
+
+Then the exposed metrics can be fetched using `curl` command at `localhost:2112/metrics`
+
+```shell
+➜  ~ curl localhost:2112/metrics
+
+# HELP promhttp_metric_handler_errors_total Total number of internal errors encountered by the promhttp metric handler.
+# TYPE promhttp_metric_handler_errors_total counter
+promhttp_metric_handler_errors_total{cause="encoding"} 0
+promhttp_metric_handler_errors_total{cause="gathering"} 0
+# HELP tetragon_errors_total The total number of Tetragon errors. For internal use only.
+# TYPE tetragon_errors_total counter
+...
+```


I think instead of repeating this, we can factorize the way to reach the metrics endpoint, maybe with tabs or simply as you did with section headers and then have a single "fetch the metrics" instead of identical ones like that.

Sure, added a "Fetch the metrics" section at the end, please take a look, and tell if it needs to be changed.

mtardy · 2023-09-22T16:56:38Z

by the way, we all reviewed while this was still a draft, please put it in ready for review when you think it's good.

mtardy · 2023-09-22T16:59:46Z

Tetragon will have an autogenerated metrics reference soon™, so there is no need to explain metrics in this PR.

Oh that's great @lambdanis, please ask me to review the PR when you do this as we need to exclude some generated files from the ownership code review thingie

tetragon/.github/CODEOWNERS

Lines 16 to 18 in 22a9fe8

    
           # Exclude some docs generated files from mtardy ownership 
        
           /docs/content/en/docs/reference/grpc-api.md @cilium/tetragon 
        
           /docs/content/en/docs/reference/helm-chart.md @cilium/tetragon

And also I'm curious about scripts, we have two at the moment for this purpose:

tixxdz

So thanks for all these changes, still 2 more things I noted them, please do fix then from my part acke'ed thanks ;-)

docs/content/en/docs/tutorials/tetragon-metrics.md

lambdanis

I left two suggestions to make things clearer, otherwise looks good.

docs/content/en/docs/tutorials/tetragon-metrics.md

Added how to read tetragon metrics with Kubernetes and Package installation setup. Signed-off-by: Prateek Singh <prateeksingh9741@gmail.com>

lambdanis

Looks good. In the future I think a tutorial running Prometheus and scraping metrics might be helpful, but this is good as the first iteration.

mtardy

I'm good with the actual state, we can merge if there are no more remarks!

prateek041 added area/documentation Improvements or additions to documentation release-note/docs This PR updates the documentation. and removed area/documentation Improvements or additions to documentation labels Sep 19, 2023

lambdanis added the area/documentation Improvements or additions to documentation label Sep 20, 2023

tixxdz approved these changes Sep 22, 2023

View reviewed changes

tixxdz mentioned this pull request Sep 22, 2023

feat: add a tutorial to access metrics #1503

Draft

lambdanis reviewed Sep 22, 2023

View reviewed changes

docs/content/en/docs/tutorials/tetragon-metrics.md Outdated Show resolved Hide resolved

docs/content/en/docs/tutorials/tetragon-metrics.md Outdated Show resolved Hide resolved

mtardy requested changes Sep 22, 2023

View reviewed changes

prateek041 force-pushed the pr/prateek/metric-tutorial branch from caf7d89 to 1ee9234 Compare September 22, 2023 18:21

prateek041 marked this pull request as ready for review September 22, 2023 18:28

prateek041 requested a review from a team as a code owner September 22, 2023 18:28

prateek041 requested review from olsajiri, lambdanis, mtardy and tixxdz September 22, 2023 18:28

tixxdz approved these changes Sep 23, 2023

View reviewed changes

docs/content/en/docs/tutorials/tetragon-metrics.md Show resolved Hide resolved

docs/content/en/docs/tutorials/tetragon-metrics.md Show resolved Hide resolved

lambdanis reviewed Sep 25, 2023

View reviewed changes

docs/content/en/docs/tutorials/tetragon-metrics.md Outdated Show resolved Hide resolved

docs/content/en/docs/tutorials/tetragon-metrics.md Outdated Show resolved Hide resolved

mtardy reviewed Sep 25, 2023

View reviewed changes

docs/content/en/docs/tutorials/tetragon-metrics.md Outdated Show resolved Hide resolved

Doc: Tetragon metrics

ee14431

Added how to read tetragon metrics with Kubernetes and Package installation setup. Signed-off-by: Prateek Singh <prateeksingh9741@gmail.com>

prateek041 force-pushed the pr/prateek/metric-tutorial branch from 1ee9234 to ee14431 Compare September 26, 2023 17:05

prateek041 requested a review from lambdanis September 26, 2023 17:08

prateek041 requested review from tixxdz and mtardy September 26, 2023 17:08

lambdanis approved these changes Sep 27, 2023

View reviewed changes

mtardy approved these changes Sep 28, 2023

View reviewed changes

lambdanis merged commit f412c92 into cilium:main Sep 29, 2023

p-linnane mentioned this pull request Nov 1, 2023

tetra 1.0.0 Homebrew/homebrew-core#153073

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc: Tetragon metrics #1495

Doc: Tetragon metrics #1495

prateek041 commented Sep 19, 2023 •

edited

Loading

netlify bot commented Sep 19, 2023 •

edited

Loading

lambdanis commented Sep 20, 2023

prateek041 commented Sep 20, 2023

tixxdz left a comment

tixxdz Sep 22, 2023

tixxdz Sep 22, 2023

prateek041 Sep 22, 2023

prateek041 Sep 22, 2023

tixxdz commented Sep 22, 2023

tixxdz commented Sep 22, 2023

michi-covalent commented Sep 22, 2023

prateek041 commented Sep 22, 2023

lambdanis left a comment

mtardy left a comment

mtardy Sep 22, 2023

prateek041 Sep 22, 2023

mtardy Sep 25, 2023

mtardy Sep 22, 2023

prateek041 Sep 22, 2023

mtardy commented Sep 22, 2023

mtardy commented Sep 22, 2023

tixxdz left a comment

lambdanis left a comment

lambdanis left a comment

mtardy left a comment


		Tetragon, when installed via release packages as mentioned in [Package Deployment](../getting-started/deployment/package.md). It can be interacted with `tetragon` command. By default, metrics are disabled, which can be enabled using `--metrics-server` flag, by specifying the address.

Doc: Tetragon metrics #1495

Doc: Tetragon metrics #1495

Conversation

prateek041 commented Sep 19, 2023 • edited Loading

netlify bot commented Sep 19, 2023 • edited Loading

✅ Deploy Preview for tetragon ready!

lambdanis commented Sep 20, 2023

prateek041 commented Sep 20, 2023

tixxdz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tixxdz commented Sep 22, 2023

tixxdz commented Sep 22, 2023

michi-covalent commented Sep 22, 2023

prateek041 commented Sep 22, 2023

lambdanis left a comment

Choose a reason for hiding this comment

mtardy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mtardy commented Sep 22, 2023

mtardy commented Sep 22, 2023

tixxdz left a comment

Choose a reason for hiding this comment

lambdanis left a comment

Choose a reason for hiding this comment

lambdanis left a comment

Choose a reason for hiding this comment

mtardy left a comment

Choose a reason for hiding this comment

prateek041 commented Sep 19, 2023 •

edited

Loading

netlify bot commented Sep 19, 2023 •

edited

Loading