-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into enable-new-search-bar-for-logs
- Loading branch information
Showing
44 changed files
with
1,478 additions
and
164 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,58 +1,49 @@ | ||
--- | ||
name: Request Dashboard | ||
about: Request a new dashboard for the SigNoz Dashboards repository | ||
title: '' | ||
title: '[Dashboard Request] ' | ||
labels: 'dashboard-template' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## 📝 Dashboard Request Template | ||
<!-- Use this template to request a new dashboard for the SigNoz Dashboards repository. Providing detailed information will help us understand your needs better and speed up the dashboard creation process. --> | ||
|
||
*Use this template to request a new dashboard for the SigNoz Dashboards repository. Please provide as much detail as possible to help us understand your needs.* | ||
## Dashboard Name | ||
|
||
--- | ||
|
||
### 1. Dashboard Name | ||
<!-- Provide the name for the requested dashboard. Be specific (e.g., "MySQL Monitoring Dashboard"). --> | ||
|
||
Name of the requested dashboard (e.g., MySQL Monitoring Dashboard): | ||
## Expected Dashboard Sections and Panels | ||
|
||
--- | ||
(Can be tweaked (add or remove panels/sections) according to available metrics) | ||
|
||
### 2. Expected Dashboard Sections and Panels | ||
### Section Name | ||
|
||
#### Section Name | ||
<!-- Brief description of what this section should display (e.g., "Resource usage metrics for MySQL database"). --> | ||
|
||
Brief description of the section (e.g., "Resource usage metrics for MySQL database"). | ||
### Panel Name | ||
|
||
#### Panel Name | ||
<!-- Description of the panel (e.g., "Displays current CPU usage, memory usage, etc."). --> | ||
|
||
Panel description (e.g., "Value-type panels displaying current CPU usage, memory usage, etc."). | ||
|
||
- **Example:** | ||
<!-- - **Example:** | ||
- **Section**: Resource Metrics | ||
- **Panel**: CPU Usage - Displays the current CPU usage across all database instances. | ||
- **Panel**: Memory Usage - Displays the total memory used by the MySQL process. | ||
|
||
(Repeat this format for additional sections and panels) | ||
- **Panel**: Memory Usage - Displays the total memory used by the MySQL process. --> | ||
|
||
--- | ||
<!-- Repeat this format for any additional sections or panels. --> | ||
|
||
### 3. Expected Variables | ||
## Expected Dashboard Variables | ||
|
||
List any variables you expect to use in the dashboard (e.g., `deployment.environment`, `hostname`, etc.). | ||
<!-- List any dashboard variables that should be included in the dashboard. Examples could be `deployment.environment`, `hostname`, `region`, etc. --> | ||
|
||
--- | ||
## Additional Comments or Requirements | ||
|
||
### 4. Additional Comments or Requirements | ||
<!-- Include any other details, special requirements, or specific visualizations you'd like to request for this dashboard. --> | ||
|
||
Any additional details or special requirements for the dashboard? | ||
## References or Screenshots | ||
|
||
--- | ||
<!-- Add any references or screenshots of requested dashboard if available. --> | ||
|
||
### 📋 Notes | ||
## 📋 Notes | ||
|
||
Please review the [CONTRIBUTING.md](https://github.com/SigNoz/dashboards/blob/main/CONTRIBUTING.md) for guidelines on dashboard structure, naming conventions, and how to submit a pull request. | ||
|
||
--- | ||
Thank you for your request! We will review it and provide feedback or guidance as necessary. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,14 +30,15 @@ Also, have a look at these [good first issues label](https://github.com/SigNoz/s | |
- [To run ClickHouse setup](#41-to-run-clickhouse-setup-recommended-for-local-development) | ||
- [Contribute to SigNoz Helm Chart](#5-contribute-to-signoz-helm-chart-) | ||
- [To run helm chart for local development](#51-to-run-helm-chart-for-local-development) | ||
- [Contribute to Dashboards](#6-contribute-to-dashboards-) | ||
- [Other Ways to Contribute](#other-ways-to-contribute) | ||
|
||
# 1. General Instructions 📝 | ||
|
||
## 1.1 For Creating Issue(s) | ||
Before making any significant changes and before filing a new issue, please check [existing open](https://github.com/SigNoz/signoz/issues?q=is%3Aopen+is%3Aissue), or [recently closed](https://github.com/SigNoz/signoz/issues?q=is%3Aissue+is%3Aclosed) issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. | ||
|
||
**Issue Types** - [Bug Report](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=bug_report.md&title=) | [Feature Request](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=feature_request.md&title=) | [Performance Issue Report](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=performance-issue-report.md&title=) | [Report a Security Vulnerability](https://github.com/SigNoz/signoz/security/policy) | ||
**Issue Types** - [Bug Report](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=bug_report.md&title=) | [Feature Request](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=feature_request.md&title=) | [Performance Issue Report](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=performance-issue-report.md&title=) | [Request Dashboard](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=dashboard-template&projects=&template=request_dashboard.md&title=%5BDashboard+Request%5D+) | [Report a Security Vulnerability](https://github.com/SigNoz/signoz/security/policy) | ||
|
||
#### Details like these are incredibly useful: | ||
|
||
|
@@ -56,7 +57,7 @@ Before making any significant changes and before filing a new issue, please chec | |
Discussing your proposed changes ahead of time will make the contribution | ||
process smooth for everyone 🙌. | ||
|
||
**[`^top^`](#)** | ||
**[`^top^`](#contributing-guidelines)** | ||
|
||
<hr> | ||
|
||
|
@@ -97,13 +98,14 @@ GitHub provides additional document on [forking a repository](https://help.githu | |
stability and quality of the component. | ||
|
||
|
||
You can always reach out to `[email protected]` to understand more about the repo and product. We are very responsive over email and [SLACK](https://signoz.io/slack). | ||
You can always reach out to `[email protected]` to understand more about the repo and product. We are very responsive over email and [slack community](https://signoz.io/slack). | ||
|
||
### Pointers: | ||
- If you find any **bugs** → please create an [**issue.**](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=bug_report.md&title=) | ||
- If you find anything **missing** in documentation → you can create an issue with the label **`documentation`**. | ||
- If you want to build any **new feature** → please create an [issue with the label **`enhancement`**.](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=&template=feature_request.md&title=) | ||
- If you want to **discuss** something about the product, start a new [**discussion**.](https://github.com/SigNoz/signoz/discussions) | ||
- If you want to request a new **dashboard template** → please create an issue [here](https://github.com/SigNoz/signoz/issues/new?assignees=&labels=dashboard-template&projects=&template=request_dashboard.md&title=%5BDashboard+Request%5D+). | ||
|
||
<hr> | ||
|
||
|
@@ -117,7 +119,7 @@ e.g. If you are submitting a fix for an issue in frontend, the PR name should be | |
|
||
- Feel free to ping us on [`#contributing`](https://signoz-community.slack.com/archives/C01LWQ8KS7M) or [`#contributing-frontend`](https://signoz-community.slack.com/archives/C027134DM8B) on our slack community if you need any help on this :) | ||
|
||
**[`^top^`](#)** | ||
**[`^top^`](#contributing-guidelines)** | ||
|
||
<hr> | ||
|
||
|
@@ -127,14 +129,13 @@ e.g. If you are submitting a fix for an issue in frontend, the PR name should be | |
|
||
- [**Frontend**](#3-develop-frontend-) (Written in Typescript, React) | ||
- [**Backend**](#4-contribute-to-backend-query-service-) (Query Service, written in Go) | ||
- [**Dashboard Templates**](#6-contribute-to-dashboards-) (JSON dashboard templates built with SigNoz) | ||
|
||
Depending upon your area of expertise & interest, you can choose one or more to contribute. Below are detailed instructions to contribute in each area. | ||
|
||
**Please note:** If you want to work on an issue, please ask the maintainers to assign the issue to you before starting work on it. This would help us understand who is working on an issue and prevent duplicate work. 🙏🏻 | ||
**Please note:** If you want to work on an issue, please add a brief description of your solution on the issue before starting work on it. | ||
|
||
⚠️ If you just raise a PR, without the corresponding issue being assigned to you - it may not be accepted. | ||
|
||
**[`^top^`](#)** | ||
**[`^top^`](#contributing-guidelines)** | ||
|
||
<hr> | ||
|
||
|
@@ -188,7 +189,7 @@ Also, have a look at [Frontend README.md](https://github.com/SigNoz/signoz/blob/ | |
### Important Notes: | ||
The Maintainers / Contributors who will change Line Numbers of `Frontend` & `Query-Section`, please update line numbers in [`/.scripts/commentLinesForSetup.sh`](https://github.com/SigNoz/signoz/blob/develop/.scripts/commentLinesForSetup.sh) | ||
|
||
**[`^top^`](#)** | ||
**[`^top^`](#contributing-guidelines)** | ||
|
||
## 3.2 Contribute to Frontend without installing SigNoz backend | ||
|
||
|
@@ -209,7 +210,7 @@ Please ping us in the [`#contributing`](https://signoz-community.slack.com/archi | |
|
||
**Frontend should now be accessible at** [`http://localhost:3301/services`](http://localhost:3301/services) | ||
|
||
**[`^top^`](#)** | ||
**[`^top^`](#contributing-guidelines)** | ||
|
||
<hr> | ||
|
||
|
@@ -309,7 +310,7 @@ Click the button below. A workspace with all required environments will be creat | |
> To use it on your forked repo, edit the 'Open in Gitpod' button URL to `https://gitpod.io/#https://github.com/<your-github-username>/signoz` --> | ||
|
||
**[`^top^`](#)** | ||
**[`^top^`](#contributing-guidelines)** | ||
|
||
<hr> | ||
|
||
|
@@ -365,10 +366,21 @@ curl -sL https://github.com/SigNoz/signoz/raw/develop/sample-apps/hotrod/hotrod- | |
| HOTROD_NAMESPACE=sample-application bash | ||
``` | ||
|
||
**[`^top^`](#)** | ||
**[`^top^`](#contributing-guidelines)** | ||
|
||
--- | ||
|
||
# 6. Contribute to Dashboards 📈 | ||
|
||
**Need to Update: [https://github.com/SigNoz/dashboards](https://github.com/SigNoz/dashboards)** | ||
|
||
To contribute a new dashboard template for any service, follow the contribution guidelines in the [Dashboard Contributing Guide](https://github.com/SigNoz/dashboards/blob/main/CONTRIBUTING.md). In brief: | ||
|
||
1. Create a dashboard JSON file. | ||
2. Add a README file explaining the dashboard, the metrics ingested, and the configurations needed. | ||
3. Include screenshots of the dashboard in the `assets/` directory. | ||
4. Submit a pull request for review. | ||
|
||
## Other Ways to Contribute | ||
|
||
There are many other ways to get involved with the community and to participate in this project: | ||
|
@@ -379,7 +391,6 @@ There are many other ways to get involved with the community and to participate | |
- Help answer questions on forums such as Stack Overflow and [SigNoz Community Slack Channel](https://signoz.io/slack). | ||
- Tell others about the project on Twitter, your blog, etc. | ||
|
||
|
||
Again, Feel free to ping us on [`#contributing`](https://signoz-community.slack.com/archives/C01LWQ8KS7M) or [`#contributing-frontend`](https://signoz-community.slack.com/archives/C027134DM8B) on our slack community if you need any help on this :) | ||
|
||
Thank You! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.