https://github.com/oslabs-beta/Periscope

https://github.com/oslabs-beta/Periscope

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/oslabs-beta/Periscope
• Owner: oslabs-beta
• Created: 2021-08-13T15:33:29.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-10T00:26:25.000Z (almost 3 years ago)
• Last Synced: 2024-04-07T01:33:41.716Z (3 months ago)
• Language: JavaScript
• Size: 6.5 MB
• Stars: 82
• Watchers: 5
• Forks: 17
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Lists

• awesome-stars - Periscope - beta | 82 | (JavaScript)

README

        
# Periscope



 



Periscope Dashboard




  [![Status](https://img.shields.io/badge/status-active-success.svg)]() 



---

 Periscope is the dashboard solution for monitoring and tracking your Kubernetes pods & nodes.

    
 

    


  Visit us at getperiscopedashboard.com



## 📝 Table of Contents

- [About](#about)

   - [Built Using](#built_using)

- [Demo](#demo)

- [Getting Started](#getting_started)

   - [Prerequisites](#prerequisites)

- [Authors](#authors)

- [Coming Soon](#coming_soon)

## 🧐 About 

 Periscope is the dashboard solution for monitoring and tracking your Kubernetes pods & nodes. 


 Periscope integrates with a Prometheus server and then displays the core metrics that any engineer needs to understand the state and health of their cluster. 

Engineers can see CPU, disk usage and memory usage across their cluster. 


 The dashboard makes it easy to see troubling trends thereby providing developers with the information needed to make changes. 


### ⛏️ Built Using 

- [Kubernetes](https://www.kubernetes.dev/)

- [Prometheus|PromQL](https://prometheus.io/)

- [React](https://reactjs.org)

- [NodeJS|Express](https://expressjs.com/)

- [Apollo GraphQL](https://www.apollographql.com/)

- [React Router](https://reactrouter.com/)

- [Locust](https://locust.io/)

- [Recharts](https://recharts.org/en-US/)

- [React Table](https://react-table.tanstack.com/)

- [Webpack](https://webpack.js.org/)

- [React Testing Library](https://testing-library.com/docs/react-testing-library/)

- [Jest](https://jestjs.io/)

## 🎥 Demo 







## 🏁 Getting Started 

Start by forking and cloning this repo. 

### Prerequisites 

- Install the [kubectl](https://kubernetes.io/docs/tasks/tools) command line tools.

- Host your Kubernetes cluster on a service like [GKE](https://cloud.google.com/kubernetes-engine) or [EKS](https://aws.amazon.com/eks/) or use [MiniKube](https://minikube.sigs.k8s.io/docs/start).

- Install [the Prometheus server](https://prometheus-operator.dev/docs/prologue/quick-start/) in order to generate your metrics

  - Save your Prometheus server on the default namespace

- Then build and run the dashboard! 

## ✍️ Authors 

- Adda Kridler: [Github](https://github.com/addakridler) | [LinkedIn](https://www.linkedin.com/in/adda-kridler-23028887/)

- Junie Hou: [Github](https://github.com/selilac) | [LinkedIn](https://www.linkedin.com/in/juniehou/)

- Ronke Oyekunle: [Github](https://github.com/ronke11) | [LinkedIn](https://www.linkedin.com/in/royekunle)

- Shawn Convery: [Github](https://github.com/smconvery) | [LinkedIn](https://www.linkedin.com/in/shawn-convery-459b79167/)

## 🎉 Coming Soon! 

- Set email / slack alerts for major changes in metrics

- Ability to enter your own PromQL query 

- Log History