|
| 1 | +# Telemetry Tools |
| 2 | + |
| 3 | +## Schema extraction tool |
| 4 | + |
| 5 | +### Description |
| 6 | + |
| 7 | +The tool is used to extract telemetry collectors schema from all `*.{ts}` files in provided plugins directories to JSON files. The tool looks for `.telemetryrc.json` files in the root of the project and in the `x-pack` dir for its runtime configurations. |
| 8 | + |
| 9 | +It uses typescript parser to build an AST for each file. The tool is able to validate, extract and match collector schemas. |
| 10 | + |
| 11 | +### Examples and restrictions |
| 12 | + |
| 13 | +**Global restrictions**: |
| 14 | + |
| 15 | +The `id` can be only a string literal, it cannot be a template literals w/o expressions or string-only concatenation expressions or anything else. |
| 16 | + |
| 17 | +``` |
| 18 | +export const myCollector = makeUsageCollector<Usage>({ |
| 19 | + type: 'string_literal_only', |
| 20 | + ... |
| 21 | +}); |
| 22 | +``` |
| 23 | + |
| 24 | +### Usage |
| 25 | + |
| 26 | +```bash |
| 27 | +node scripts/telemetry_extract.js |
| 28 | +``` |
| 29 | + |
| 30 | +This command has no additional flags or arguments. The `.telemetryrc.json` files specify the path to the directory where searching should start, output json files, and files to exclude. |
| 31 | + |
| 32 | + |
| 33 | +### Output |
| 34 | + |
| 35 | + |
| 36 | +The generated JSON files contain an ES mapping for each schema. This mapping is used to verify changes in the collectors and as the basis to map those fields into the external telemetry cluster. |
| 37 | + |
| 38 | +**Example**: |
| 39 | + |
| 40 | +```json |
| 41 | +{ |
| 42 | + "properties": { |
| 43 | + "cloud": { |
| 44 | + "properties": { |
| 45 | + "isCloudEnabled": { |
| 46 | + "type": "boolean" |
| 47 | + } |
| 48 | + } |
| 49 | + } |
| 50 | + } |
| 51 | +} |
| 52 | +``` |
| 53 | + |
| 54 | +## Schema validation tool |
| 55 | + |
| 56 | +### Description |
| 57 | + |
| 58 | +The tool performs a number of checks on all telemetry collectors and verifies the following: |
| 59 | + |
| 60 | +1. Verifies the collector structure, fields, and returned values are using the appropriate types. |
| 61 | +2. Verifies that the collector `fetch` function Type matches the specified `schema` in the collector. |
| 62 | +3. Verifies that the collector `schema` matches the stored json schema . |
| 63 | + |
| 64 | +### Notes |
| 65 | + |
| 66 | +We don't catch every possible misuse of the collectors, but only the most common and critical ones. |
| 67 | + |
| 68 | +What will not be caught by the validator: |
| 69 | + |
| 70 | +* Mistyped SavedObject/CallCluster return value. Since the hits returned from ES can be typed to anything without any checks. It is advised to add functional tests that grabs the schema json file and checks that the returned usage matches the types exactly. |
| 71 | + |
| 72 | +* Fields in the schema that are never collected. If you are trying to report a field from ES but that value is never stored in ES, the check will not be able to detect if that field is ever collected in the first palce. It is advised to add unit/functional tests to check that all the fields are being reported as expected. |
| 73 | + |
| 74 | +The tool looks for `.telemetryrc.json` files in the root of the project and in the `x-pack` dir for its runtime configurations. |
| 75 | + |
| 76 | +Currently auto-fixer (`--fix`) can automatically fix the json files with the following errors: |
| 77 | + |
| 78 | +* incompatible schema - this error means that the collector schema was changed but the stored json schema file was not updated. |
| 79 | + |
| 80 | +* unused schemas - this error means that a collector was removed or its `type` renamed, the json schema file contains a schema that does not have a corrisponding collector. |
| 81 | + |
| 82 | +### Usage |
| 83 | + |
| 84 | +```bash |
| 85 | +node scripts/telemetry_check --fix |
| 86 | +``` |
| 87 | + |
| 88 | +* `--path` specifies a collector path instead of checking all collectors specified in the `.telemetryrc.json` files. Accepts a `.ts` file. The file must be discoverable by at least one rc file. |
| 89 | +* `--fix` tells the tool to try to fix as many violations as possible. All errors that tool won't be able to fix will be reported. |
0 commit comments