github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/packages/kbn-eslint-plugin-telemetry
History
Coen Warmer 772bc0c598
Enable "Event Generating Elements Should Be Instrumented" ESLint rule for more O11y Apps (#165647) 
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2023-09-05 15:48:03 -04:00
..
helpers Enable "Event Generating Elements Should Be Instrumented" ESLint rule for more O11y Apps (#165647) 2023-09-05 15:48:03 -04:00
rules Enable "Event Generating Elements Should Be Instrumented" ESLint rule for more O11y Apps (#165647) 2023-09-05 15:48:03 -04:00
index.ts ESLint Telemetry Rule (#153108) 2023-03-20 13:31:02 +00:00
jest.config.js ESLint Telemetry Rule (#153108) 2023-03-20 13:31:02 +00:00
kibana.jsonc ESLint Telemetry Rule (#153108) 2023-03-20 13:31:02 +00:00
package.json ESLint Telemetry Rule (#153108) 2023-03-20 13:31:02 +00:00
README.mdx ESLint Telemetry Rule (#153108) 2023-03-20 13:31:02 +00:00
tsconfig.json ESLint Telemetry Rule (#153108) 2023-03-20 13:31:02 +00:00

README.mdx 

---
id: kibDevDocsOpsEslintPluginTelemetry
slug: /kibana-dev-docs/ops/kbn-eslint-plugin-telemetry
title: '@kbn/eslint-plugin-telemetry'
description: Custom ESLint rules to support telemetry in the Kibana repository
tags: ['kibana', 'dev', 'contributor', 'operations', 'eslint', 'telemetry']
---

`@kbn/eslint-plugin-telemetry` is an ESLint plugin providing custom rules for validating JSXCode in the Kibana repo to make sure it can be instrumented for the purposes of telemetry.

## `@kbn/telemetry/instrumentable_elements_should_be_instrumented`

This rule warns engineers to add `data-test-subj` to instrumentable components. It currently suggests the most widely used EUI components (`EuiButton`, `EuiFieldText`, etc), but can be expanded with often-used specific components used in the Kibana repo.