tp: Update metric related docs
Bug:239310180
Change-Id: If64372c99a6778eb08d12c78080b35baaa4b4ae3
diff --git a/docs/analysis/metrics.md b/docs/analysis/metrics.md
index 6d2213c..7aaba2d 100644
--- a/docs/analysis/metrics.md
+++ b/docs/analysis/metrics.md
@@ -84,8 +84,8 @@
can run the following commands from a Perfetto checkout:
```python
> ./tools/trace_processor --interactive \
- --run_metrics android_startup \
- --metric-extension src/trace_processor/metrics@/
+ --run-metrics android_startup \
+ --metric-extension src/trace_processor/metrics@/ \
--dev \
<trace>
android_startup {
@@ -109,7 +109,7 @@
This also works for custom metrics specified on the command line:
```python
-> ./tools/trace_processor -i --run_metrics /tmp/my_custom_metric.sql <trace>
+> ./tools/trace_processor -i --run-metrics /tmp/my_custom_metric.sql <trace>
my_custom_metric {
<contents of my_custom_metric>
}
@@ -139,7 +139,7 @@
For example, from inside a Perfetto checkout:
```python
> ./tools/trace_processor \
- --run_metrics android_cpu \
+ --run-metrics android_cpu \
--metric-extension src/trace_processor/metrics@/
--dev
<trace>
diff --git a/docs/contributing/common-tasks.md b/docs/contributing/common-tasks.md
index 5ef5dae..e34eb03 100644
--- a/docs/contributing/common-tasks.md
+++ b/docs/contributing/common-tasks.md
@@ -20,6 +20,8 @@
2. Import the proto in [protos/perfetto/metrics/metrics.proto](/protos/perfetto/metrics/metrics.proto) and add a field for the new message.
3. Run `tools/gen_all out/YOUR_BUILD_DIRECTORY`. This will update the generated headers containing the descriptors for the proto.
* *Note: this step has to be performed any time any metric-related proto is modified.*
+ * If you don't see anything inside the `out/` directory you might have to
+ rerun `tools/build_all_configs.py`.
4. Add a new SQL file for the metric to [src/trace_processor/metrics](/src/trace_processor/metrics). The appropriate `BUILD.gn` file should be updated as well.
* To learn how to write new metrics, see the [trace-based metrics documentation](/docs/analysis/metrics.md).
5. Build all targets in your out directory with `tools/ninja -C out/YOUR_BUILD_DIRECTORY`.
