Guidelines for Submitting a Package to LogScale Marketplace
We would love you to share your packages with other LogScale customers via our marketplace. Currently the marketplace is only available from within the LogScale product UI but in future, the marketplace will also be available from the LogScale public website.
After receiving the package and the required additional information detailed below, LogScale will check the package by following a simple certification process which is explained here. Once complete (including any required modifications) the package will be made available on the marketplace.
To ask for help or advice please get in touch with us via our public Slack channel.
To complete the package creation process so that it can be submitted to the Marketplace now edit the yaml files to include the below information.
As a general rule you should only add information as detailed below and should leave existing data in the files as this was input via the package creation process in the LogScale product.
To send a package to LogScale, email the zip file containing the package
<email@example.com>. You must include the following in
Duplication — Describes restrictions related to the duplitcation of a package.
Additional Metadata — Additional information related to the package for example a list of contributers.
Sample Log Files — Some sample logs files which allow the package to be tested.
LogScale Package Certification — Certification Process which is applied to package for the to put on the marketplace.
Documentation — Details on they type of docuemntation which must be provide for a package.
LogScale Best Practices — Some general best practices to apply when creating a package.
Security — The security guidelines to follow when creating a package.
Branding — The branding which should be applied to a package.
The package does not duplicate an existing package or overlap in functionality so significantly that it would make more sense to make a change to an existing package.
If any aspect of the package requires changes, then LogScale will identify these to the package creator and offer advice on how to make the changes needed to be included in the marketplace. LogScale may also make the changes directly during the package review.
You can include contributors in the package metadata. This will be displayed in the marketplace next to the package. Contributors can list the names of developers and can include email addresses if you are happy for this to be visible in the marketplace.
Sample Log Files
To ensure that LogScale can test the package functionality we need to have some available log files which include all the events that are relevant to the package. Ideally LogScale would like log data over a 24 hour period, but if all event types can be covered in a shorter period of time that may be acceptable. Depending on the size of the log files either attach the log files to the email or provide a link to the files and any required credentials to access these. The sample logs are mandatory for package review, and must:
Exercise all panels, alerts, and queries in the package
Be a representative sample of real event distribution for the package
Not contain any PII or other sensitive information
The log file samples are covered by the same Apache 2.0 license as your package submission. LogScale may use these sample logs to generate demo environments, screenshots, marketing materials, etc. When developing or extending an existing package LogScale may make these sample logs available to other developers.
LogScale Package Certification
On receipt of the package and required information detailed above LogScale will check that the package meets our guidelines and requirements as follows. This is a simple process and we are here to help so if you are unsure of anything please get in touch with us!
The package works with the provided log samples. Testing will include, but is not limited to: Data is parsed correctly and all dashboards and alerts work as expected and provide a good overall user experience.
The provided descriptions and metadata included within the package, including the README and the additional information provided via the email, correctly describe the package and are clear and unambiguous and comply with the requirements in this document. The available sample log files cover all relevant events.
LogScale Best Practices
LogScale components of the package (parsers, queries,
dashboard , alerts) are
implemented in an efficient manner using the optimal implementation
and configurations. Queries are constructed efficiently and with the
optimal query language, dashboards display
clearly with appropriate labels etc. For any guidance on LogScale's
recommendations please consult our documentation on this site, and if
in doubt please contact us for assistance via
<firstname.lastname@example.org>> or on our public
All links within the package descriptions and metadata are checked for malware.
All company names and logos are used appropriately.