https://github.com/bpftrace/user-tools

Community contributed tools
https://github.com/bpftrace/user-tools

Last synced: about 2 months ago
JSON representation

Community contributed tools

• Host: GitHub
• URL: https://github.com/bpftrace/user-tools
• Owner: bpftrace
• License: gpl-2.0
• Created: 2024-04-04T14:06:54.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-07-23T13:22:03.000Z (5 months ago)
• Last Synced: 2024-07-23T15:33:45.046Z (5 months ago)
• Size: 39.1 KB
• Stars: 10
• Watchers: 7
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# user-tools

This repository contains [community contributed tools](TOOLS.md). This is different from

[official bpftrace tools][0] in that we do not intend to be as strict about

requirements.

Thus, we encourage users to contribute anything they find useful for the

community. Motivations could include (but are not limited to):

* Sharing useful functionality

* Sharing novel techniques

* Incubating a new official tool

One intention is that all new official tools begin life in this repository. And

over time we'll develop some criteria for promoting a user tool to an official

tool that bpftrace maintainers will help support over long periods of time.

[0]: https://github.com/bpftrace/bpftrace/blob/master/CONTRIBUTING-TOOLS.md

## [Tools List](TOOLS.md)

## [How to Contribute a New Tool](CONTRIBUTING.md)

If you want to contribute bpftrace tools to this repo, please follow 

[these guidelines](CONTRIBUTING.md).

## Packaging

This repository **should NOT be packaged and distributed**. It is essentially a

large collection of unsupported, possibly broken, sample code. This is not a 

typical software project but rather a programmer's community, similar to a

subreddit. The only bpftrace tools that are packaged are those included in the

primary [bpftrace repository](https://github.com/bpftrace/bpftrace/tree/master/tools).

## Licensing

Depending on which [BPF helpers](kernel-versions.md#helpers) are used by 

bpftrace when compiling your program, a GPL-compatible license is required for 

bpftrace programs/tools.

You can set the license as a comment in your source code (at the top of the 

file). Note: it supports multiple words and quotes are not necessary. **If the 

license is not specified, bpftrace will automatically define the license of the 

program as GPL v2.**

Examples:

- `// SPDX-License-Identifier: GPL-2.0-or-later`

- `// SPDX-License-Identifier: GPL-2.0-or-later OR BSD-2-Clause`

Currently, only these licenses are supported in this repo:

- GPL

- GPL v2

- Dual BSD/GPL

- Dual MIT/GPL

- Dual MPL/GPL

Note: GPL v3 is not supported.