nri-kubernetes

README

New Relic integration for Kubernetes

New Relic's Kubernetes integration gives you full observability into the health and performance of your environment, no matter whether you run Kubernetes on-premises or in the cloud. It gives you visibility about Kubernetes namespaces, deployments, replica sets, nodes, pods, and containers. Metrics are collected from different sources:

• kube-state-metrics service provides information about state of Kubernetes objects like namespace, replicaset, deployments and pods (when they are not in running state)
• /stats/summary kubelet endpoint gives information about network, errors, memory and CPU usage
• /pods kubelet endpoint provides information about state of running pods and containers
• /metrics/cadvisor cAdvisor endpoint provides missing data that is not included in the previous sources.
• /metrics from control plane components: ETCD,controllerManager, apiServer and scheduler

Check out our documentation in order to find out more how to install and configure the integration, learn what metrics are captured and how to query them.

Table of contents

• Table of contents
• Installation
• Usage
• Running the integration against a static data set
• Development
  • E2E tests
  • Tests
• Running OpenShift locally using CodeReady Containers
• Support
• Contributing
• License

Installation

Start by checking the compatibility and requirements and then follow the installation steps.

For troubleshooting, see Not seeing data or Error messages.

Helm chart

You can install this chart using nri-bundle located in the helm-charts repository or directly from this repository by adding this Helm repository:

helm repo add nri-kubernetes https://newrelic.github.io/nri-kubernetes
helm upgrade --install nri-kubernetes/newrelic-infrastructure -f your-custom-values.yaml

For further information of the configuration needed for the chart just read the chart's README.

Usage

Learn how to find and use data and review the description of all captured data.

Running the integration against a static data set

• See cmd/kubernetes-static/readme.md for more details regarding running the integration.
• See internal/testutil/datagen/README.md for more details regarding generate new data.

Development

Run e2e Tests

• See e2e/README.md for more details regarding running e2e tests.

Tests

For running unit tests, run

make test

Run local development environment

We use Minikube and Tilt to spawn a local environment that it will reload after any changes inside the charts or the integration code.

Make sure you have these tools or install them:

• Install minikube
• Install Tilt
• Install Helm

Create a values-local.yaml file from the values-local.yaml.sample using a valid license key and your cluster name.

Start the local environment:

make local-env-start

Notice that local images are build and pushed to docker running inside the minikube cluster since we are running eval $(minikube docker-env) before launching Tilt.

Running OpenShift locally using CodeReady Containers

• See OpenShift.md for more details regarding running locally OpenShift environments.

Support

Should you need assistance with New Relic products, you are in good hands with several support diagnostic tools and support channels.

New Relic offers NRDiag, a client-side diagnostic utility that automatically detects common problems with New Relic agents. If NRDiag detects a problem, it suggests troubleshooting steps. NRDiag can also automatically attach troubleshooting data to a New Relic Support ticket. Remove this section if it doesn't apply.

If the issue has been confirmed as a bug or is a feature request, file a GitHub issue.

Support Channels

• New Relic Documentation: Comprehensive guidance for using our platform
• New Relic Community: The best place to engage in troubleshooting questions
• New Relic Developer: Resources for building a custom observability applications
• New Relic University: A range of online training for New Relic users of every level
• New Relic Technical Support 24/7/365 ticketed support. Read more about our Technical Support Offerings.

Privacy

At New Relic we take your privacy and the security of your information seriously, and are committed to protecting your information. We must emphasize the importance of not sharing personal data in public forums, and ask all users to scrub logs and diagnostic information for sensitive information, whether personal, proprietary, or otherwise.

We define “Personal Data” as any information relating to an identified or identifiable individual, including, for example, your name, phone number, post code or zip code, Device ID, IP address, and email address.

For more information, review New Relic’s General Data Privacy Notice.

Contribute

We encourage your contributions to improve this project! Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.

If you have any questions, or to execute our corporate CLA (which is required if your contribution is on behalf of a company), drop us an email at opensource@newrelic.com.

A note about vulnerabilities

As noted in our security policy, New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.

If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through HackerOne.

If you would like to contribute to this project, review these guidelines.

To all contributors, we thank you! Without your contribution, this project would not be what it is today.

License

nri-kubernetes is licensed under the Apache 2.0 License.