From 5ed1668ef172db9ceee2eea0372d2d1867853f75 Mon Sep 17 00:00:00 2001 From: Jack Berg Date: Wed, 31 Jan 2024 11:27:21 -0600 Subject: [PATCH] Add schema modeling guidance to use wildcard syntax instead of regex --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 430e026..a639582 100644 --- a/README.md +++ b/README.md @@ -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`.