Outlyer Plugin

api for definining native Outlyer Plugins

class Plugin:
    """
    The Plugin API.
    Users must derive from this class when implementing a custom Plugin
    """
    def collect(self) -> Status:
        """Perform collections operations for the provided Target"""

    def gauge(self, name: str, labels: Optional[dict]) -> Gauge:
        """Get a Gauge instance for the specified Name/Labels"""

    def counter(self, name: str, labels: Optional[dict]) -> Counter:
        """Get a Counter instance for the specified Name/Labels"""

    def get(self, key: str, default: any) -> any:
        """Get a Target config property"""

Usage

from outlyer_plugin import Plugin, Status

class MyPlugin(Plugin):
    def collect(self):
        self.gauge(f'sys.cpu.user.pct').set(55)
        return Status.OK

if __name__ == '__main__':
    # To run the collection
    sys.exit(MyPlugin().run())

Metadata

Release files for outlyer-plugin 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for outlyer-plugin 0.0.1
File	Size	Uploaded	Provenance	Actions
outlyer-plugin-0.0.1.tar.gz	4.3 kB	Jan 10, 2019	Without provenance	Details for outlyer-plugin-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for outlyer-plugin 0.0.1
File	Interpreter	ABI	Platform	Actions Reset
outlyer_plugin-0.0.1-py3-none-any.whl 5.0 kB Jan 10, 2019 Without provenance	Python 3	none	any	Details for outlyer_plugin-0.0.1-py3-none-any.whl

Total release size: 9.3 kB

Release files / outlyer-plugin-0.0.1.tar.gz

Download URL	outlyer-plugin-0.0.1.tar.gz
Size	4.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`d2410a932c1a557f3384b8d6e712639541f65e448740c618157b14514989a797`
BLAKE2b-256 checksum How to use checksums	`3af29c3baa12971c30783364f57ea899d9118fb7d496785f060a10b15e5b6306`
Upload date	Jan 10, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.7.0`

Release files / outlyer_plugin-0.0.1-py3-none-any.whl

Download URL	outlyer_plugin-0.0.1-py3-none-any.whl
Size	5.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`0d79fecf4336de4e65d7d83344264a8f7cb8c584add66cbf4845f5f8bcb43d78`
BLAKE2b-256 checksum How to use checksums	`662bfaa0b060effb0fb81e718acdf98496bd378e3b15a01afd5fdb9cdb405588`
Upload date	Jan 10, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.7.0`

Security for outlyer-plugin 0.0.1

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

Jan 10, 2019 2 release files No provenance

outlyer-plugin 0.0.1