From a1909106cf1bc08a7e0dbec67d53b90aff237e10 Mon Sep 17 00:00:00 2001 From: Andreas Thaler Date: Thu, 5 Sep 2024 16:14:40 +0200 Subject: [PATCH] Add missing parts for reuse compliance --- .reuse/dep5 | 18 +++++------------- README.md | 10 ++++++++-- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/.reuse/dep5 b/.reuse/dep5 index 96d499f..6e92c2b 100755 --- a/.reuse/dep5 +++ b/.reuse/dep5 @@ -1,7 +1,7 @@ Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ -Upstream-Name: -Upstream-Contact: -Source: +Upstream-Name: Kyma +Upstream-Contact: +Source: https://github.com/kyma-project/kyma Disclaimer: The code in this project may include calls to APIs ("API Calls") of SAP or third-party products or services developed outside of this project ("External Products"). @@ -24,14 +24,6 @@ Disclaimer: The code in this project may include calls to APIs ("API Calls") of you any rights to use or access any SAP External Product, or provide any third parties the right to use of access any SAP External Product, through API Calls. -Files: -Copyright: SAP SE or an SAP affiliate company and contributors +Files: * +Copyright: 2024 SAP SE or an SAP affiliate company and Kyma contributors License: Apache-2.0 - -Files: -Copyright: -License: - -Files: -Copyright: -License: \ No newline at end of file diff --git a/README.md b/README.md index 987287e..3043137 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,13 @@ # Kyma Metrics Collector +## Status + +[![REUSE status](https://api.reuse.software/badge/github.com/kyma-project/kyma-metrics-collector)](https://api.reuse.software/info/github.com/kyma-project/kyma-metrics-collector) + +![GitHub tag checks state](https://img.shields.io/github/checks-status/kyma-project/kyma-metrics-collector/main?label=kyma-metrics-collector&link=https%3A%2F%2Fgithub.com%2Fkyma-project%2Fkyma-metrics-collector%2Fcommits%2Fmain) + ## Overview -Kyma Metrics Collector (KMC) is a component that scrapes all Kyma clusters to generate metrics. These metrics are sent to Event Data Platform [(EDP)](https://pages.github.tools.sap/edp/edp-docs/docs/overview/tutorial/) as an event stream and used for billing information. +Kyma Metrics Collector (KMC) is a component that scrapes all Kyma clusters to generate metrics. These metrics are sent to an SAP internal tool called Event Data Platform (EDP) as an event stream and used for billing information. ## Functionality The basic flow for KMC is as follows: @@ -9,7 +15,7 @@ The basic flow for KMC is as follows: * KMC adds the runtimes to a queue to work through them. If an error occurs, KMC re-queues the affected runtime. * Information on PVCs, SVCs and Nodes is retrieved from SAP BTP, Kyma runtime (SKR). * This information is sent to EDP as an event stream. - * For every process step, internal metrics are collected with [Prometheus](https://prometheus.io/docs/introduction/overview/) and alerts have been configured to trigger if any part of the functionality malfunctions. See the [metrics.md](metrics.md) file. + * For every process step, internal metrics are exposed with the [Prometheus client library](https://github.com/prometheus/client_golang). See the [metrics.md](metrics.md) file for exposed metrics. ## Usage