erolunal
commented
1 month ago Types
| Old | New |
|---|---|
| BasePublisherModel | BasePublisher |
| BaseTagModel | BaseEventModel |
| DefaultTagCatalogOptions | DefaultCatalogOptions |
| StratumEvent | StratumSnapshot |
| StratumEventListenerFn | StratumSnapshotListenerFn |
| StratumEventPluginData | StratumSnapshotPluginData |
| TagCatalog | StratumCatalog |
| TagCatalog.tags | StratumCatalog.items |
| TagCatalogErrors | CatalogErrors |
| TagCatalogMetadata | CatalogMetadata |
| TagCatalogOptions | CatalogOptions |
| TagId | EventId |
| TagKey | CatalogKey |
| TagObject | CatalogEvent |
| TagOptionReplacement | EventReplacement |
| TagOptionReplacementFn | EventReplacementFn |
| TagOptions | EventOptions |
| UserDefinedTagCatalogOptions | UserDefinedCatalogOptions |
| UserDefinedTagOptions | UserDefinedEventOptions |
| RegisteredTagCatalog | RegisteredStratumCatalog |
| StratumService.publishTag() | StratumService.publish() |
| Publisher.getTagOutput() | Publisher.getModelOutput() |
| Publisher.shouldPublishTag() | Publisher.shouldPublishEvent() |
jasonvanderslice
What's the problem you are facing? Rename the types and references in the Stratum library to better align OTEL's terminology and industry standards.
Describe the solution you're proposing Main changes are removing references to the word "tag" across various types and internal comments and renaming to something that aligns more closely with known observability verbiage. (see issue comments for detailed changes)
Additional context This change does contain breaking changes but will be released as a minor version change due to the infancy of the project. We will assist with future PRs and contributors affected appropriately.
Note that any Stratum enhancements should add general functionality that applies to a broad range of users. If you're looking to add custom functionality to your specific application, we recommend creating or extending existing plugins when possible.
Next steps