├── .gitignore ├── README.md ├── SUPPORT.md ├── SECURITY.md ├── CODE_OF_CONDUCT.md └── CONTRIBUTING.md /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | _Community health files for the @netdata organization_ 2 | 3 | Read more: [GitHub Docs](https://docs.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file) 4 | -------------------------------------------------------------------------------- /SUPPORT.md: -------------------------------------------------------------------------------- 1 | # Support for using Netdata 2 | 3 | Welcome to the Netdata community! It's great to have you. Because Netdata is open-source at its core, we're always listening to community members just like you for suggestions on how we could make Netdata even better. 4 | 5 | If you need help with Netdata: 6 | 7 | - Visit [Netdata Learn](https://learn.netdata.cloud/), our education portal. 8 | - Create a new topic on our community forums, in the [**Support** category](https://community.netdata.cloud/c/support/13/none). 9 | - If you're not sure how to ask a good question, check out the [topic](https://community.netdata.cloud/t/how-to-submit-a-good-question/469/7) we created of tips to help us help you. 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | This document describes how Netdata handles vulnerability reports. If you are a Netdata user, please also read our [security and privacy design](https://github.com/netdata/netdata/blob/master/docs/security-and-privacy-design/README.md). 4 | 5 | ## Supported Versions 6 | 7 | | Version | Supported | 8 | |------- | --------- | 9 | | Latest stable | Yes | 10 | | Latest nightly | Yes | 11 | 12 | Important security fixes always result in a patch release to the latest stable. 13 | 14 | ## Reporting a Vulnerability 15 | 16 | We're extremely grateful for security researchers and users that report vulnerabilities to Netdata Open Source Community. All reports are thoroughly investigated by a set of community volunteers. 17 | 18 | For possible vulnerabilities of the **FOSS agent**, [open a draft security advisory](https://github.com/netdata/netdata/security/advisories/new). 19 | 20 | For all other reports, please send an email to **security@netdata.cloud** with 21 | the vulnerability details and the details expected for [all Netdata bug 22 | reports](https://github.com/netdata/netdata/blob/master/.github/ISSUE_TEMPLATE/BUG_REPORT.yml). 23 | 24 | ### Awards 25 | 26 | We reward newly reported vulnerabilities with Netdata swag. We do not offer monetary awards for vulnerability reports. 27 | 28 | ### When Should I Report a Vulnerability? 29 | 30 | - You think you discovered a potential security vulnerability in Netdata 31 | - You are unsure how a vulnerability affects Netdata 32 | - You think you discovered a vulnerability in another project that Netdata depends on (e.g. python, node, etc) 33 | 34 | ### When Should I NOT Report a Vulnerability? 35 | 36 | - You need help tuning Netdata for security 37 | - You need help applying security related updates 38 | - Your issue is not security related 39 | 40 | ### Security Vulnerability Response 41 | 42 | Each report is acknowledged and analyzed by Netdata Team members within 3 working days. This will set off a Security Release Process. 43 | 44 | Any vulnerability information shared with the Netdata Team stays within the Netdata project and will not be disseminated to other projects unless it is necessary to get the issue fixed. 45 | 46 | As the security issue moves from triage, to identified fix, to release planning we will keep the reporter updated. 47 | 48 | ### Public Disclosure Timing 49 | 50 | A public disclosure date is negotiated by the Netdata team and the bug submitter. We prefer to fully disclose the bug as soon as possible once a user mitigation is available. It is reasonable to delay disclosure when the bug or the fix is not yet fully understood, the solution is not well-tested, or for vendor coordination. The timeframe for disclosure is from immediate (especially if it's already publicly known) to a few weeks. As a basic default, we expect report date to disclosure date to be on the order of 7 days. The Netdata team holds the final say when setting a disclosure date. 51 | 52 | ### Security Announcements 53 | 54 | Every time a security issue is fixed in Netdata, we immediately release a new version of it. So, to get notified of all security incidents, please subscribe to our releases on github. 55 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | 8 | 9 | # Netdata Community Code of Conduct 10 | 11 | ## Our Pledge 12 | 13 | In the interest of fostering an open and welcoming environment, we as 14 | contributors, maintainers and community members pledge to making participation in our project and 15 | our community a harassment-free experience for everyone, regardless of age, body 16 | size, disability, ethnicity, sex characteristics, gender identity and expression, 17 | level of experience, education, socio-economic status, nationality, personal 18 | appearance, race, religion, or sexual identity and orientation. 19 | 20 | ## Our Standards 21 | 22 | Examples of behavior that contributes to creating a positive environment 23 | include: 24 | 25 | - Using welcoming and inclusive language 26 | - Being respectful of differing viewpoints and experiences 27 | - Gracefully accepting constructive criticism 28 | - Focusing on what is best for the community 29 | - Showing empathy towards other community members 30 | 31 | Examples of unacceptable behavior by participants include: 32 | 33 | - The use of sexualized language or imagery and unwelcome sexual attention or 34 | advances 35 | - Trolling, insulting/derogatory comments, and personal or political attacks 36 | - Public or private harassment 37 | - Publishing others' private information, such as a physical or electronic 38 | address, without explicit permission 39 | - Other conduct which could reasonably be considered inappropriate in a 40 | professional setting 41 | 42 | ## Our Responsibilities 43 | 44 | Project maintainers are responsible for clarifying the standards of acceptable 45 | behavior and are expected to take appropriate and fair corrective action in 46 | response to any instances of unacceptable behavior. 47 | 48 | Project maintainers have the right and responsibility to remove, edit, or 49 | reject comments, commits, code, documentation edits, issues, community posts, and other contributions 50 | that are not aligned to this Code of Conduct, or to ban temporarily or 51 | permanently any contributor for other behaviors that they deem inappropriate, 52 | threatening, offensive, or harmful. 53 | 54 | ## Scope 55 | 56 | This Code of Conduct applies both within project spaces and in public spaces 57 | when an individual is representing the project or its community. Examples of 58 | representing a project or community include using an official project e-mail 59 | address, posting via an official social media account, or acting as an appointed 60 | representative at an online or offline event. Representation of a project may be 61 | further defined and clarified by project maintainers. 62 | 63 | ## Enforcement 64 | 65 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 66 | reported by contacting Netdata at info@netdata.cloud. All 67 | complaints will be reviewed and investigated and will result in a response that 68 | is deemed necessary and appropriate to the circumstances. The project team is 69 | obligated to maintain confidentiality with regard to the reporter of an incident. 70 | Further details of specific enforcement policies may be posted separately. 71 | 72 | Project maintainers who do not follow or enforce the Code of Conduct in good 73 | faith may face temporary or permanent repercussions as determined by other 74 | members of the project's leadership. 75 | 76 | ## Attribution 77 | 78 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 79 | available at 80 | 81 | [homepage]: https://www.contributor-covenant.org 82 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Thank you for considering contributing to Netdata! 4 | 5 | Maintaining a platform for monitoring everything requires a vast knowledge base. We rely on community contributions and user feedback to continue to provide the best monitoring solution. 6 | 7 | There are many ways to contribute, with varying skill requirements, explained in detail in the following sections. 8 | 9 | One good way to start is searching through [specific GitHub issues](https://github.com/netdata/netdata/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22) we need help with. Some of them are also labeled as "good first issue". 10 | 11 | ## Give Netdata a GitHub star 12 | 13 | GitHub stars are a great way to show your appreciation for open-source projects like Netdata. Starring Netdata helps us in several ways: 14 | 15 | - **Increases project discoverability**: More stars make Netdata more visible to others searching for monitoring solutions on GitHub. 16 | - **Attracts valuable contributors**: A high star count signals to developers that Netdata is a thriving project worth contributing to. This can lead to more features, bug fixes, and overall project improvement. 17 | 18 | If you enjoy using Netdata, consider giving it a 🌟! 19 | 20 | ## Join the Netdata Community 21 | 22 | Engage with the Netdata community and get help, share knowledge, and contribute to the project's future! Here are the ways to connect: 23 | 24 | - [GitHub Discussions](https://github.com/netdata/netdata/discussions): Discuss technical topics, ask questions, and get help from the Netdata developers and community. 25 | - [Discord server](https://discord.com/invite/2mEmfW735j): Chat with other Netdata users in real-time, share experiences, and get quick answers. 26 | - [Community Forum](https://community.netdata.cloud): Find in-depth discussions, tutorials, and ask questions on a dedicated forum platform. 27 | 28 | ### Contribute collectors 29 | 30 | Netdata lets you add custom data sources through collector plugins. Before diving in, check our [collector documentation](https://github.com/netdata/netdata/blob/master/src/collectors/README.md) to understand how they work. 31 | 32 | The Netdata Agent has a modular approach to collecting data from data sources, meaning that we have a number of collector plugins that send data to the Netdata Agent. For each collector plugin, you can create a new module which collects data from a data source. 33 | 34 | To contribute a new collector: 35 | 36 | - **Go**: Follow the guide [How to write a Netdata collector in Go](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/docs/how-to-write-a-module.md). 37 | - **Python**: Refer to the [collector's README](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/README.md). 38 | - **Shell/Bash**: Refer to the [charts.d documentation](https://github.com/netdata/netdata/blob/master/src/collectors/charts.d.plugin/README.md). 39 | - **StatsD**: Unfamiliar with StatsD? We have an [intro](https://www.netdata.cloud/blog/introduction-to-statsd/) and [reference docs](https://github.com/netdata/netdata/blob/master/src/collectors/statsd.plugin/README.md). 40 | 41 | ### Contribute alerts 42 | 43 | Netdata comes pre-configured with alerts for common monitoring needs. You can help improve these in two ways: 44 | 45 | 1. **Modify or add alerts**: Enhance existing alerts or define new ones for specific use cases. 46 | 2. **Alerts for new collectors**: If you contribute a new collector, consider including basic alerts for it. 47 | 48 | To do both, you'll need to create or modify alert configuration files. The process is covered in the [Health Reference](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md) documentation. 49 | 50 | ### Contribute alert notifications 51 | 52 | Netdata Agent supports sending notifications for various monitoring alerts. The Agent uses alerts to trigger notifications and then executes a script called `alarm-notify.sh`. 53 | 54 | To modify existing notifications or create new ones, you'll need to use Bash scripting. 55 | 56 | Here are ways to get started: 57 | 58 | - **Copy existing notifications**: Look at the structure of already implemented notifications within `alarm-notify.sh` and adapt them for your needs. 59 | - **Use custom endpoint as boilerplate**: Look at the [custom endpoint notification](https://github.com/netdata/netdata/blob/master/src/health/notifications/custom/README.md) as a starting point for your custom notification script. 60 | --------------------------------------------------------------------------------