Skip to content

Commit

Permalink
Merge pull request #243 from sysdiglabs/staging
Browse files Browse the repository at this point in the history
Staging
  • Loading branch information
carlosadiegosysdig authored Oct 17, 2022
2 parents c2e7f87 + 5d1cce8 commit fc29b3a
Show file tree
Hide file tree
Showing 513 changed files with 184 additions and 165,880 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,16 @@ You can find all the content organized and ready to use in [promcat.io](https://
<p align="center"><img width="500" src="images/promcat-screenshot.png"></p>

# What can I find?
PromCat comes as a crossroad for anyone that is looking for how to monitor a cloud application either with Prometheus or with Sysdig Monitor.
PromCat comes as a crossroad for anyone that is looking for how to monitor a cloud application with Prometheus.

Here you will find the following contents for each application:
* Setup Guides: A complete step-by-step guide to install and configure the Prometheus exporter or the metrics module of the application.
* Dashboards: A set of dashboards to monitor for trouble-shooting and metrics exploration of the application. All dashboards are offered in both [Sysdig Monitor](https://sysdig.com/products/monitor/) and [Grafana](https://github.com/grafana/grafana) formats.
* Dashboards: A set of dashboards to monitor for trouble-shooting and metrics exploration of the application. All dashboards are in [Grafana](https://github.com/grafana/grafana) format.
* Alerts: A set of curated alerts for the application.
* Recording Rules: A set of recording rules.

# Who can use the resources?
PromCat has two main use cases:
* Sysdig customers: As a Sysdig customer, in PromCat you will find all the resources needed to setup exporters to be scraped by the Sysdig Agent and a set of ready to use dashboards and alerts.
* Any Prometheus user: Thanks to the [native compatibility of the Sysdig Agent with Prometheus](https://sysdig.com/opensource/prometheus/), the same setup guides, dashboards and alerts can be used by any Prometheus user that needs to monitor cloud applications.
The setup guides, dashboards and alerts can be used by any Prometheus user that needs to monitor cloud applications.

# Contributing
As any open source project, all contributions are welcome.
Expand Down
4 changes: 2 additions & 2 deletions apps/aws-eks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apiVersion: v1
kind: App
name: AWS EKS
keywords:
- Available
- Coming soon
- AWS
- Kubernetes
availableVersions:
Expand All @@ -13,4 +13,4 @@ description: |
# AWS EKS with Fargate
icon: https://raw.githubusercontent.com/sysdiglabs/promcat-resources/master/apps/images/aws-eks.png
website: https://aws.amazon.com/eks/
available: true
available: false
4 changes: 2 additions & 2 deletions apps/cassandra.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ kind: App
name: "cassandra"
keywords:
- Database
- Available
- Coming soon
availableVersions:
- '3.11.6'
shortDescription: "Apache Cassandra is a free and open-source, distributed NoSQL database"
description: |
Apache Cassandra is a free and open-source, distributed, wide column store, NoSQL database management system designed to handle large amounts of data across many commodity servers, providing high availability with no single point of failure.
icon: https://upload.wikimedia.org/wikipedia/commons/5/5e/Cassandra_logo.svg
website: https://cassandra.apache.org/
available: true
available: false
4 changes: 2 additions & 2 deletions apps/etcd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apiVersion: v1
kind: App
name: "etcd"
keywords:
- Available
- Coming soon
- Kubernetes
availableVersions:
- '3.4.0'
Expand All @@ -13,4 +13,4 @@ description: |
icon: https://raw.githubusercontent.com/cncf/artwork/master/projects/etcd/horizontal/color/etcd-horizontal-color.png
website: https://etcd.io/
available: true
available: false
3 changes: 1 addition & 2 deletions apps/istio.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ name: "Istio"
keywords:
- Kubernetes
- Available
availableVersions:
- '1.5'
availableVersions:
- '1.14'
shortDescription: "Istio service mesh. Connect, secure, control, and observe services."
description: |
Expand Down
4 changes: 1 addition & 3 deletions apps/kubernetes-control-plane.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@ name: "Kubernetes control plane"
keywords:
- Kubernetes
- Available
availableVersions:
- '1.14.0'
- '1.18.0'
availableVersions:
- '1.22.0'
shortDescription: Open-source system for automating deployment, scaling, and management of containerized applications.
description: |
Expand Down
4 changes: 2 additions & 2 deletions apps/openshift.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ name: "Openshift"
keywords:
- Platform
- Kubernetes
- Available
- Coming soon
availableVersions:
- '3.11'
- '4.3'
Expand All @@ -14,4 +14,4 @@ description: |
The Kubernetes platform for big ideas
icon: https://upload.wikimedia.org/wikipedia/commons/3/3a/OpenShift-LogoType.svg
website: https://www.openshift.com/
available: true
available: false
4 changes: 2 additions & 2 deletions apps/rancher.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ kind: App
name: "Rancher"
keywords:
- Platform
- Available
- Coming soon
- Kubernetes
availableVersions:
- '2.5.0'
Expand All @@ -13,4 +13,4 @@ description: |
# Rancher is open source software that combines everything an organization needs to adopt and run containers in production.
icon: https://raw.githubusercontent.com/sysdiglabs/promcat-resources/master/apps/images/rancher.png
website: https://rancher.com/
available: true
available: false
File renamed without changes.
22 changes: 1 addition & 21 deletions resources/aws-eks/INSTALL.md → future-apps/aws-eks/INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Prerequisites
KSM and cAdvisor generates a high number of metrics. As the Sysdig Agent has a limit of time series that can send to Sysdig Monitor, you have to deploy a Prometheus server and create the recording rules that we provide. This way, you will filter only the metrics that you need.

To deploy a Prometheus server you will need:
* [helm](https://helm.sh/docs/intro/install/)
Expand Down Expand Up @@ -36,23 +35,4 @@ kubectl -n monitoring patch sts prometheus-server -p '{"spec":{"template":{"meta

```
kubectl -n monitoring apply -f prometheus-deploy.yaml
```

# Configuring the Sysdig Agent
To install the Sysdig Agent, ensure that you have at least one EC2 instance in your EKS cluster.

1. Install with helm Sysdig Agent in your cluster:

```
kubectl create ns sysdig-agent
helm install -n sysdig-agent \
--set sysdig.accessKey=<YOUR-ACCESS-KEY> \
--set sysdig.settings.k8s_cluster_name=<YOUR-CLUSTER-NAME> \
sysdig-agent sysdiglabs/sysdig
```

2. Download the sample [Sysdig Agent configuration file](include/sysdig-agent-config.yaml) and apply it:

```
kubectl apply -f sysdig-agent-config.yaml
```
```
File renamed without changes.
File renamed without changes.
7 changes: 7 additions & 0 deletions future-apps/aws-eks/dashboards.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
apiVersion: v1
kind: Dashboard
app: 'AWS EKS'
version: 1.0.0
appVersion:
- "1.15-1.17"
configurations: []
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,4 @@ configurations:
file: include/prometheus-deploy.yaml
- name: prometheus-cm.yaml
file: include/prometheus-cm.yaml
- name: sysdig-agent.yaml
file: include/sysdig-agent.yaml
descriptionFile: INSTALL.md
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,23 @@ appVersion:
- '3.11.6'
configurations:
- name: 'Cassandra overview'
kind: Sysdig
image: 'cassandra/images/cassandra-sysdig.png'
kind: Grafana
image: 'cassandra/images/cassandra-grafana.png'
description: |
This dashboard offers information on:
* Dropped Messages
* Nodes up
* ClientRead avg duration
* ClientWrite avg duration
* JVM Heap usage
* Pending compactions
* Commitlog tasks
* Storage exceptions
* Pending tasks
* Unavailable exceptions
* Available disk
* 95thPercentile read latency
* 95thPercentile write latency
* Avaiable disk by instance
* Users conected
* Tombstones scanned
* CQL statements
* Keyspace and tables
file: include/dashboard-Sysdig--1.0.0.json
* CPU load ratio
* JVM usage
* Cassandra
file: include/dashboard-Grafana--1.0.0.json
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ spec:
template:
metadata:
annotations:
promcat.sysdig.com/integration_type: cassandra
promcat.sysdig.com/port: "5556"
prometheus.io/scrape: "true"
prometheus.io/port: "5556"
spec:
containers:
- image: quay.io/sysdig/promcat-jmx-exporter:v0.17.3
Expand Down
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions future-apps/etcd/INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Prerequisites
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,6 @@ version: 1.0.0
appVersion:
- '3.4.0'
configurations:
- name: 'etcd'
kind: Sysdig
image: etcd/images/etcd_sysdig.png
description: |
This dashboard offers information on:
* Etcd has a leader?
* The number of leader changes seen
* The total number of failed proposals seen
* RPC Rate
* Active Streams
* DB Size
* Disk Sync Duration
* The total number of consensus proposals committed
* Memory
* CPU usage
* Goroutines
file: include/dashboard-Sysdig---etcd.json
- name: 'etcd'
kind: Grafana
image: etcd/images/etcd_grafana.png
Expand Down
File renamed without changes.
File renamed without changes
8 changes: 8 additions & 0 deletions future-apps/etcd/setup-guide.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
apiVersion: v1
kind: SetupGuide
app: etcd
version: 1.0.0
appVersion:
- 3.4.0
configurations: []
descriptionFile: INSTALL.md
Loading

0 comments on commit fc29b3a

Please sign in to comment.