Skip to content

Commit

Permalink
Fix lint
Browse files Browse the repository at this point in the history
Signed-off-by: Pete Wall <[email protected]>
  • Loading branch information
petewall committed Nov 4, 2024
1 parent c6ae20f commit 7765cb1
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 20 deletions.
24 changes: 14 additions & 10 deletions charts/feature-integrations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,35 +114,39 @@ Actual integration testing in a live environment should be done in the main [k8s

To contribute integrations to this feature, there are a few files that need to be created or modified:

- `values.yaml` - The main feature chart's values file. Add a section for your integration. It must contain an
* `values.yaml` - The main feature chart's values file. Add a section for your integration. It must contain an
`instance` array and any settings that apply to every instance of the integration. For example:

```yaml
<slug>:
instances: []
globalSetting: value
```
- `integrations/<slug>-values.yaml` - The values that will be used for each instance. This must include `name` to

* `integrations/<slug>-values.yaml` - The values that will be used for each instance. This must include `name` to
differentiate it from other instances, and any other settings that are specific to that instance. For example:

```yaml
name: ""
labelSelectors:
app.kubernetes.io/name: my-service
protocol: http
...
```
- `templates/_integration<=_<slug>.tpl` - The file that contains template functions that build the configuration to

* `templates/_integration<=_<slug>.tpl` - The file that contains template functions that build the configuration to
discover, gather, process, and deliver the telemetry data. This file is required to implement the following template
functions:
- `integrations.<slug>.type.metrics` - Returns true if this integration scrapes metrics.
- `integrations.<slug>.type.logs` - Returns true if this integration gathers logs.
- `integrations.<slug>.module` - Returns the configuration that is included once if this integration is used. This
* `integrations.<slug>.type.metrics` - Returns true if this integration scrapes metrics.
* `integrations.<slug>.type.logs` - Returns true if this integration gathers logs.
* `integrations.<slug>.module` - Returns the configuration that is included once if this integration is used. This
is typically the module definition.
- `integrations.<slug>.include.metrics` - Returns the configuration that is included for each instance of the
* `integrations.<slug>.include.metrics` - Returns the configuration that is included for each instance of the
integration that scrapes metrics.
- `integrations.<slug>.include.logs` - Returns the configuration that is included for each instance of the
* `integrations.<slug>.include.logs` - Returns the configuration that is included for each instance of the
integration that gathers logs.
- `integrations.<slug>.exclude.logs` - Returns a rule that can be used by other Log-gathering features to ensure
* `integrations.<slug>.exclude.logs` - Returns a rule that can be used by other Log-gathering features to ensure
that logs that are gathered from this integration are not collected twice. Typically the inverse of a rule in
the `integrations.<slug>.include.logs` function.
- `default-allow-lists/<slug>.yaml` - If the integration scrapes metrics, a common pattern is to provide a list of
* `default-allow-lists/<slug>.yaml` - If the integration scrapes metrics, a common pattern is to provide a list of
metrics that should be allowed. This minimizes the amount of metrics delivered to a useful minimal set.
24 changes: 14 additions & 10 deletions charts/feature-integrations/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -71,35 +71,39 @@ Actual integration testing in a live environment should be done in the main [k8s

To contribute integrations to this feature, there are a few files that need to be created or modified:

- `values.yaml` - The main feature chart's values file. Add a section for your integration. It must contain an
* `values.yaml` - The main feature chart's values file. Add a section for your integration. It must contain an
`instance` array and any settings that apply to every instance of the integration. For example:

```yaml
<slug>:
instances: []
globalSetting: value
```
- `integrations/<slug>-values.yaml` - The values that will be used for each instance. This must include `name` to

* `integrations/<slug>-values.yaml` - The values that will be used for each instance. This must include `name` to
differentiate it from other instances, and any other settings that are specific to that instance. For example:

```yaml
name: ""
labelSelectors:
app.kubernetes.io/name: my-service
protocol: http
...
```
- `templates/_integration<=_<slug>.tpl` - The file that contains template functions that build the configuration to

* `templates/_integration<=_<slug>.tpl` - The file that contains template functions that build the configuration to
discover, gather, process, and deliver the telemetry data. This file is required to implement the following template
functions:
- `integrations.<slug>.type.metrics` - Returns true if this integration scrapes metrics.
- `integrations.<slug>.type.logs` - Returns true if this integration gathers logs.
- `integrations.<slug>.module` - Returns the configuration that is included once if this integration is used. This
* `integrations.<slug>.type.metrics` - Returns true if this integration scrapes metrics.
* `integrations.<slug>.type.logs` - Returns true if this integration gathers logs.
* `integrations.<slug>.module` - Returns the configuration that is included once if this integration is used. This
is typically the module definition.
- `integrations.<slug>.include.metrics` - Returns the configuration that is included for each instance of the
* `integrations.<slug>.include.metrics` - Returns the configuration that is included for each instance of the
integration that scrapes metrics.
- `integrations.<slug>.include.logs` - Returns the configuration that is included for each instance of the
* `integrations.<slug>.include.logs` - Returns the configuration that is included for each instance of the
integration that gathers logs.
- `integrations.<slug>.exclude.logs` - Returns a rule that can be used by other Log-gathering features to ensure
* `integrations.<slug>.exclude.logs` - Returns a rule that can be used by other Log-gathering features to ensure
that logs that are gathered from this integration are not collected twice. Typically the inverse of a rule in
the `integrations.<slug>.include.logs` function.
- `default-allow-lists/<slug>.yaml` - If the integration scrapes metrics, a common pattern is to provide a list of
* `default-allow-lists/<slug>.yaml` - If the integration scrapes metrics, a common pattern is to provide a list of
metrics that should be allowed. This minimizes the amount of metrics delivered to a useful minimal set.

0 comments on commit 7765cb1

Please sign in to comment.