Skip to content

Commit

Permalink
Add schema modeling guidance to use wildcard syntax instead of regex
Browse files Browse the repository at this point in the history
  • Loading branch information
jack-berg committed Jan 31, 2024
1 parent c5128cc commit 5ed1668
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,14 @@ Allowable changes:
- For major versions: All changes are permitted.
- For minor versions: TBD

## Naming guidelines
## Schema Modeling Guidelines

The following defines guidelines used to produce configuration schema:
The following guidelines are used to model the configuration schema:

1. To remove redundant information from the configuration file, prefixes for data produced by each of the providers
* To remove redundant information from the configuration file, prefixes for data produced by each of the providers
will be removed from configuration options. For example, under the `meter_provider` configuration, metric readers will be
identified by the word `readers` rather than by `metric_readers`. Similarly, the prefix `span_` will be dropped for tracer
provider configuration, and `logrecord` for logger provider.
* Use wildcard `*` (match any number of any character, including none) and `?` (match any single character) instead of regex. If a single property with
wildcards is likely to be insufficient, accept an array of strings with wildcard with entries joined with a logical OR. For example, given `["foo*", "bar*"]`,
match on any value that starts with `foo` OR `bar`.

0 comments on commit 5ed1668

Please sign in to comment.