tricorder-observability / Starship

Starship: next-generation Observability platform built with eBPF+WASM
GNU Affero General Public License v3.0
163 stars 23 forks source link

[RFC] New consistent file naming for module directory #250

Open nascentcore-eng opened 1 year ago

nascentcore-eng commented 1 year ago

What's the motivation? Is it related to a problem? Please describe the background and rationale. Currently an eBPF+WASM module's files do not have consistent naming inside the module's directory. For example, ddos_event's directory looks as below: image

This creates confusion for readers, and likely causes actual engineering toils in the near future when we want to provide more client-side tooling for Starship users.

Describe the solution you'd like The new naming schema:

Describe alternatives you've considered

Additional context, for example, Kubernetes versions, Kernel versions etc. This change potentially helps implementing a new module distribution mechanism in https://github.com/tricorder-observability/Starship/issues/68; as a consistent file naming schema allows easier automation in building distributed packages.

nascentcore-eng commented 1 year ago

An example is in https://github.com/tricorder-observability/Starship/tree/main/modules/sample_json

nascentcore-eng commented 1 year ago

The Web UI and CLI would need to be updated to take advantage of this new naming scheme.

nascentcore-eng commented 1 year ago

@feuyeux @owl-ltt @zhoujie16 WDYT?