Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hodgesds committed Jul 20, 2019
1 parent 6ffc121 commit 4e104a8
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ subsystem in Linux. It can read any kernel tracepoints and expose them as
Prometheus compatible metrics.

## Configuration
The configuration format allows you to specific specific profilers at the
subsytem level. For each subsytem individual events can be configured. Note
that configuring a subsystem event for a specific processor isn't supported as
of now. To find available events for your system you can use the perf tooling
The configuration format allows you to specific profilers at the subsytem
level. For each subsytem individual events can be configured. Note that
configuring a subsystem event for a specific processor isn't supported as of
now. To find available events for your system you can use the perf tooling
(i.e. `perf list`) or you can read directly from tracefs `available_events` in
combination with the `tools/tracepoint2yaml` script. Here is a rough example
of a configuration file to get started (note this is ***highly*** system
Expand Down Expand Up @@ -58,7 +58,6 @@ Here is an example of some of the events that can be exposed:
- How is perf being used? You may want to see this
[library](https://github.com/hodgesds/perf-utils) which is where most of the
perf related utilities are.
- Should I use this in production? Probably not yet, this is pretty experimental software.
- I don't see values for my perf events, is the collector broken? This is
difficult to debug due to a large number of factors at play. Everything from
the way your kernel was configured to debugfs mount points can cause an
Expand Down

0 comments on commit 4e104a8

Please sign in to comment.