bda.plone.prometheusexporter


Namebda.plone.prometheusexporter JSON
Version 1.0a1 PyPI version JSON
download
home_pageNone
SummaryPrometheus Exporter for Plone and Zope
upload_time2024-10-10 09:23:45
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseGPL 2.0
keywords plone prometheus
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Prometheus Exporter for Plone

This Plone add-on provides a `/metrics` endpoint on Plone site root.

It provides metrics of the ZODB and Plone.

## WIP, Features

Info:
- [x] Zope version
- [x] Python version
- [x] Plone versions (core)
- [x] debug mode
- [ ] add-ons installed
- [ ] add-ons available

ZODB (per DB):
- [x] Number of objects in the DBs
- [x] Database Size (MB)

Plone content:
- [x] number of objects by type
- [ ] number of objects by state

## Installation

- add `bda.plone.prometheusexporter` to your `requirements.txt` or append it to the `dependencies` list of your `pyproject.toml` file.
- add `bda.plone.prometheusexporter` to the `zcml_package_includes` of your `instance.yaml` or include it in your integration packages `configure.zcml` file.
- (re-)install the dependencies of your project, (re-)run `cookiecutter-zope-instance` 
- start Plone
- in the browser, install the add-on in your Plone sites add-on control panel or depend on the profile `profile-bda.plone.prometheusexporter:default` in your integration packages `profiles/default/metadata.xml` file and (re)-install the integration package profile.

## Source Code

The sources are in a GIT DVCS with its main branches at `github <https://github.com/bluedynamics/bda.plone.prometheusexporter>`_.
There you can report issues too.

We'd be happy to see many forks and pull-requests to make this addon even better.

Maintainers are `Jens Klein <mailto:jk@kleinundpartner.at>` and the BlueDynamics Alliance developer team.
We appreciate any contribution and if a release is needed to be done on PyPI, please just contact one of us.
We also offer commercial support if any training, coaching, integration or adaptions are needed.



## License

The project is licensed under the GPLv2.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "bda.plone.prometheusexporter",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "Jens Klein <jk@kleinundpartner.at>",
    "keywords": "plone, prometheus",
    "author": null,
    "author_email": "Jens Klein <jk@kleinundpartner.at>",
    "download_url": "https://files.pythonhosted.org/packages/1d/69/a781040461e4d2af9778cf27fc52e57d3cf616cd846c8d33ae95da82adaa/bda_plone_prometheusexporter-1.0a1.tar.gz",
    "platform": null,
    "description": "# Prometheus Exporter for Plone\n\nThis Plone add-on provides a `/metrics` endpoint on Plone site root.\n\nIt provides metrics of the ZODB and Plone.\n\n## WIP, Features\n\nInfo:\n- [x] Zope version\n- [x] Python version\n- [x] Plone versions (core)\n- [x] debug mode\n- [ ] add-ons installed\n- [ ] add-ons available\n\nZODB (per DB):\n- [x] Number of objects in the DBs\n- [x] Database Size (MB)\n\nPlone content:\n- [x] number of objects by type\n- [ ] number of objects by state\n\n## Installation\n\n- add `bda.plone.prometheusexporter` to your `requirements.txt` or append it to the `dependencies` list of your `pyproject.toml` file.\n- add `bda.plone.prometheusexporter` to the `zcml_package_includes` of your `instance.yaml` or include it in your integration packages `configure.zcml` file.\n- (re-)install the dependencies of your project, (re-)run `cookiecutter-zope-instance` \n- start Plone\n- in the browser, install the add-on in your Plone sites add-on control panel or depend on the profile `profile-bda.plone.prometheusexporter:default` in your integration packages `profiles/default/metadata.xml` file and (re)-install the integration package profile.\n\n## Source Code\n\nThe sources are in a GIT DVCS with its main branches at `github <https://github.com/bluedynamics/bda.plone.prometheusexporter>`_.\nThere you can report issues too.\n\nWe'd be happy to see many forks and pull-requests to make this addon even better.\n\nMaintainers are `Jens Klein <mailto:jk@kleinundpartner.at>` and the BlueDynamics Alliance developer team.\nWe appreciate any contribution and if a release is needed to be done on PyPI, please just contact one of us.\nWe also offer commercial support if any training, coaching, integration or adaptions are needed.\n\n\n\n## License\n\nThe project is licensed under the GPLv2.\n",
    "bugtrack_url": null,
    "license": "GPL 2.0",
    "summary": "Prometheus Exporter for Plone and Zope",
    "version": "1.0a1",
    "project_urls": {
        "Changelog": "https://github.com/bluedynamics/bda.plone.prometheusexporter/blob/main/CHANGES.md",
        "Issues": "https://github.com/bluedynamics/bda.plone.prometheusexporter/issues",
        "PyPI": "https://pypi.python.org/pypi/bda.plone.prometheusexporter",
        "Source": "https://github.com/bluedynamics/bda.plone.prometheusexporter"
    },
    "split_keywords": [
        "plone",
        " prometheus"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "427d9a48e77686b74c93d237ef4c9a405c3abd877a37ab84a72130007a99ec4f",
                "md5": "ce1b8c74dc92f8a4b95f8e7648ef25bf",
                "sha256": "abdcf041e1a4683a87e4c00be98814cfaae3830f1a294079b33904b5e7099afc"
            },
            "downloads": -1,
            "filename": "bda_plone_prometheusexporter-1.0a1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ce1b8c74dc92f8a4b95f8e7648ef25bf",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 14361,
            "upload_time": "2024-10-10T09:23:43",
            "upload_time_iso_8601": "2024-10-10T09:23:43.622562Z",
            "url": "https://files.pythonhosted.org/packages/42/7d/9a48e77686b74c93d237ef4c9a405c3abd877a37ab84a72130007a99ec4f/bda_plone_prometheusexporter-1.0a1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1d69a781040461e4d2af9778cf27fc52e57d3cf616cd846c8d33ae95da82adaa",
                "md5": "8522512fd4b1011b8e755dc352173692",
                "sha256": "30f3079e8861dfcc6003f21c71c8c1ca78fe3b7df8cdb45d7d447a0af2474d48"
            },
            "downloads": -1,
            "filename": "bda_plone_prometheusexporter-1.0a1.tar.gz",
            "has_sig": false,
            "md5_digest": "8522512fd4b1011b8e755dc352173692",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 12174,
            "upload_time": "2024-10-10T09:23:45",
            "upload_time_iso_8601": "2024-10-10T09:23:45.622743Z",
            "url": "https://files.pythonhosted.org/packages/1d/69/a781040461e4d2af9778cf27fc52e57d3cf616cd846c8d33ae95da82adaa/bda_plone_prometheusexporter-1.0a1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-10 09:23:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bluedynamics",
    "github_project": "bda.plone.prometheusexporter",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "bda.plone.prometheusexporter"
}
        
Elapsed time: 1.37975s