search

intelsdi-x / snap

The open telemetry framework
http://snap-telemetry.io
Apache License 2.0
1.8k stars 295 forks source link

Recommend, but don't require, plugins use semantic versioning on versions #1429

Open mbbroberg opened 7 years ago

mbbroberg commented 7 years ago

We moved to SemVer for the Snap framework. It would be valuable to have the same for each plugin. Could we recommend - in documentation and through logs/errors - that plugins do the same?

One place to do so would be upon loading a plugin: 

$ snaptel plugin load /vagrant/plugins/snap-plugin-collector-perfevents
Warning loading plugin:
Plugin version does not follow semantic versioning syntax. Semantic versioning is not required, but it is recommended. Read the latest best practices for plugins at: http://pluginauthoring.snap-telemetry.io

Where pluginauthoring.snap-telemetry.io is a redirect to PLUGIN_AUTHORING.md for now and later could be external documentation (I just set this up).

nanliu commented 7 years ago

Linking issue with #276 and #1403. @mjbrender any objections if I collapse this with #1403?

mbbroberg commented 7 years ago

@nanliu I'm game for rearrangement as you clean up these issues. This issue is a particular implementation idea that seems dependent on the result of #1403 but could be solved independently. I'm good with however you want to roll up these pieces.