From 107d58be4d8cc5c1ef52ca74eefa6bdc1884e2f8 Mon Sep 17 00:00:00 2001 From: Bradley Camacho Date: Wed, 6 Sep 2023 14:29:54 -0700 Subject: [PATCH 1/2] feat(tutorials): k8 iteration --- .../tutorial-k8s-intro.mdx | 14 +++++++++----- src/nav/tutorial-understand-k8s.yml | 8 ++++---- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/src/content/docs/tutorial-kubernetes-learn/tutorial-k8s-intro.mdx b/src/content/docs/tutorial-kubernetes-learn/tutorial-k8s-intro.mdx index 1c8ffc12e80..1310415a59c 100644 --- a/src/content/docs/tutorial-kubernetes-learn/tutorial-k8s-intro.mdx +++ b/src/content/docs/tutorial-kubernetes-learn/tutorial-k8s-intro.mdx @@ -13,9 +13,9 @@ import apmApmCompleteSummaryPage from 'images/apm_screenshot-full_apm-complete-s import infraComplete from 'images/infrastructure_screenshot-full_infra-main.webp' -A Kubernetes system is inherently complex and has a reputation as challenging to grasp. Understanding Kubernetes as a concept is a complex task by itself and wanting to understand an specific Kubernetes system only adds more complexity. How do you troubleshoot ephemeral containers that spin up and down before you can even access them? How do you understand the health of your system as a whole if you have hundreds of containers orchestrated at a time? How do you parse out the intricate systems into functional layers? +A Kubernetes system is inherently complex and has a reputation as challenging to grasp. Understanding Kubernetes as a concept is a complex task by itself and wanting to understand a specific Kubernetes system only adds more complexity. How do you troubleshoot ephemeral containers that spin up and down before you can access them? How do you understand the health of your system as a whole if you have hundreds of containers orchestrated at a time? How do you parse out the intricate systems into functional layers? -In this tutorial series, you will learn how to monitor your Kubernetes system with New Relic and how it can streamline your understanding of the Kubernetes as a whole. +In this tutorial series, you will learn how to monitor your Kubernetes system with New Relic and how it can streamline your understanding of the Kubernetes as a whole. -The New Relic Kubernetes integration gives you full observability into the health and performance of your environment. With the data it provides, you can monitor the health of your entire Kubernetes cluster or drill down to a single pod. This agent collects telemetry data from your cluster using several New Relic integrations such as the Kubernetes events integration, the Prometheus Agent, and the New Relic Logs Kubernetes plugin. +The New Relic Kubernetes integration gives you full observability into the health and performance of your environment. With the data it provides, you can monitor the health of your entire Kubernetes cluster, check individual pods, or drill into specific services and applications. This agent collects telemetry data from your cluster using several New Relic integrations such as the Kubernetes events integration, the Prometheus Agent, and the New Relic Logs Kubernetes plugin. There are various ways to integrate your Kubernetes system. For this tutorial series, we highly recommend using the guided install steps below. For other install paths, see [our Kubernetes install docs](/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-integration-install-configure/). @@ -87,13 +87,17 @@ There are various ways to integrate your Kubernetes system. For this tutorial se -Additionally, you can start monitoring Kubernetes clusters using our Auto-telemetry with Pixie. [Learn more about Auto-telemetry with Pixie here](/docs/kubernetes-pixie/auto-telemetry-pixie/get-started-auto-telemetry-pixie/). +Additionally, you can start monitoring Kubernetes clusters using our Auto-telemetry with Pixie. [Learn more about Auto-telemetry with Pixie here](/docs/kubernetes-pixie/auto-telemetry-pixie/get-started-auto-telemetry-pixie/). + +This tutorial does not cover Pixie concepts, but there are [various other tutorials you can follow](https://docs.px.dev/tutorials/pixie-101/). ### Send data from your applications -Kubernetes excels at abstracting the toil one runs into when managing containerized workloads. That abstraction adds complexity when correlating individual applications to their underlying infrastructure. To reduce this complexity, you can report data from your applications and services to New Relic and directly correlate them to their place within the Kubernetes cluster. +Running dozens or hundreds of containers causes toil and difficulty. Kubernetes abstracts containers into higher level concepts, with the cluster as the highest level. This abstraction helps you understand your cluster as a whole, but makes it difficult to understand what is happening at an application level. + +To reduce this complexity, you can report data from your containerzied applications to New Relic. This not only allows you to see the health of your applications, but also allows you to correlate application data to the underlying Kubernetes infrastructure. Date: Mon, 11 Sep 2023 07:07:14 -0700 Subject: [PATCH 2/2] fix(k8s): various style edits --- .../tutorial-k8s-intro.mdx | 12 ++++++------ .../tutorial-k8s-layers.mdx | 16 ++++++++-------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/content/docs/tutorial-kubernetes-learn/tutorial-k8s-intro.mdx b/src/content/docs/tutorial-kubernetes-learn/tutorial-k8s-intro.mdx index 1310415a59c..8ad94d06a46 100644 --- a/src/content/docs/tutorial-kubernetes-learn/tutorial-k8s-intro.mdx +++ b/src/content/docs/tutorial-kubernetes-learn/tutorial-k8s-intro.mdx @@ -87,17 +87,17 @@ There are various ways to integrate your Kubernetes system. For this tutorial se -Additionally, you can start monitoring Kubernetes clusters using our Auto-telemetry with Pixie. [Learn more about Auto-telemetry with Pixie here](/docs/kubernetes-pixie/auto-telemetry-pixie/get-started-auto-telemetry-pixie/). +Additionally, you can monitor Kubernetes clusters using our Auto-telemetry with Pixie. [Learn more about Auto-telemetry with Pixie here](/docs/kubernetes-pixie/auto-telemetry-pixie/get-started-auto-telemetry-pixie/). -This tutorial does not cover Pixie concepts, but there are [various other tutorials you can follow](https://docs.px.dev/tutorials/pixie-101/). +This tutorial doesn't cover Pixie concepts, but there are [various other tutorials you can follow](https://docs.px.dev/tutorials/pixie-101/). ### Send data from your applications -Running dozens or hundreds of containers causes toil and difficulty. Kubernetes abstracts containers into higher level concepts, with the cluster as the highest level. This abstraction helps you understand your cluster as a whole, but makes it difficult to understand what is happening at an application level. +Running dozens or hundreds of containers causes toil and difficulty to maintain. Kubernetes abstracts containers into higher level concepts, with the cluster as the highest level. This abstraction helps you understand your cluster as a whole, but makes it difficult to understand what is happening at an application level. -To reduce this complexity, you can report data from your containerzied applications to New Relic. This not only allows you to see the health of your applications, but also allows you to correlate application data to the underlying Kubernetes infrastructure. +To reduce this complexity, you can report data from your containerzied applications to New Relic. This not only allows you to see the health of your applications, but also lets you correlate application data to the underlying Kubernetes infrastructure. -To confirm you're sending all your Kubernetes related data to New Relic, explore the Kubernetes charts. Go to **[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Kubernetes**. Poke around your data and see if you can get a general sense of the health of your Kubernetes system. Confirm you're seeing data for your entire cluster, individual pods, and any services and applications you expect. Once you're ready, proceed to the next steps. +To confirm you're sending all your Kubernetes related data to New Relic, explore the Kubernetes charts. Go to **[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Kubernetes**. Poke around your data and see if you can get a general sense your Kubernetes system's health. Confirm you're seeing data for your entire cluster, individual pods, and any services and applications you expect. Once you're ready, proceed to the next steps. ## Next steps -You're now sending Kubernetes data to New Relic! From here you can start using the power of New Relic to gauge the health of your system and understand how it's all working together by following the rest of this tutorial series. Each doc will dive into how New Relic can help monitor and understand an individual layer of Kubernetes. +You're now sending Kubernetes data to New Relic! The next steps in this tutorial will teach you to gauge the health of your system and understand how it's all working together. Each doc will dive into how New Relic can help monitor and understand an individual layer of Kubernetes. -There are many ways you can split up a Kubernetes system to understand it; these layers are just one way to think of your system. +There are many ways you can split up a Kubernetes system to understand it; these layers are just one way to think about your system. ## Understand and monitor the cluster layer -In a large Kubernetes system, with numerous deployments and pods, manually monitoring each component becomes impractical. You might be dealing with dozens or hundred of deployments, which in turn means you might have to monitor hundreds or thousands of individual pods. New Relic offers a more efficient approach to oversee the entire system's health and receive timely alerts when issues arise. +In a large Kubernetes system, with numerous deployments and pods, manually monitoring each component becomes impractical. You might be dealing with dozens or hundred of deployments, which in turn means you might have to monitor hundreds or thousands of individual pods, services, and applications. New Relic offers a more efficient approach to oversee the entire system's health and receive timely alerts when issues arise. The following steps guide your through a general monitoring strategy for your cluster: @@ -58,7 +58,7 @@ If you don't see any data, [make sure you set up your monitoring ](/docs/tutoria ### Triage your cluster -The Kubernetes overview dashboard shows your high level data about your cluster. You can find general data such as the count of pods and services, but more importantly you can find data about the health of your cluster such as the percent of pods running, the count of failed pods, the number of container restarts, and more. +The Kubernetes overview dashboard shows your high level data about your cluster. You can find general data such as the count of pods and services. More importantly you can find data about the health of your cluster such as the percentage of pods running, the count of failed pods, the number of container restarts, and more. The main overview dashboard for the kubernetes capability -there are various graphs that show things such as pending pods over time or even memory utilization over time. +there are various graphs that show things such as pending pods over time or memory utilization over time. -Spike are fairly normal, such as the spikes in the **Kubernetes Warning Events by Reason** graph in the screenshot above. These spikes happen regularly about every 5 minutes so they are no cause for concern. Look for spikes that happen outside of regular patterns or spike in a much larger magnitude than normal. +Spike are not always cause for concern, such as the spikes in the **Kubernetes Warning Events by Reason** graph in the screenshot above. These spikes happen regularly about every 5 minutes so they don't raise any red flags. Look for spikes that happen outside of regular patterns or spikes in a much larger magnitude than normal. @@ -106,7 +106,7 @@ Spike are fairly normal, such as the spikes in the **Kubernetes Warning Events b Node readiness -Observe whether nodes in the cluster are ready and able to host pods. Ensure that your cluster's infrastructure is prepared to handle workloads without any bottlenecks. +Observe whether nodes in the cluster are ready and able to host pods. Ensure that your cluster's infrastructure can handle workloads without any bottlenecks.