{"id":37074539,"url":"https://github.com/marklogic-community/newrelic-plugin","last_synced_at":"2026-01-14T08:47:16.537Z","repository":{"id":52416852,"uuid":"62821068","full_name":"marklogic-community/newrelic-plugin","owner":"marklogic-community","description":"A New Relic plugin for monitoring MarkLogic","archived":true,"fork":false,"pushed_at":"2021-05-12T15:10:22.000Z","size":87,"stargazers_count":1,"open_issues_count":4,"forks_count":6,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-10-27T04:28:46.512Z","etag":null,"topics":["marklogic","monitoring","newrelic","plugin"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/newrelic-marklogic-plugin/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marklogic-community.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-07T16:17:19.000Z","updated_at":"2023-01-27T19:03:23.000Z","dependencies_parsed_at":"2022-09-03T03:13:45.346Z","dependency_job_id":null,"html_url":"https://github.com/marklogic-community/newrelic-plugin","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/marklogic-community/newrelic-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marklogic-community%2Fnewrelic-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marklogic-community%2Fnewrelic-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marklogic-community%2Fnewrelic-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marklogic-community%2Fnewrelic-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marklogic-community","download_url":"https://codeload.github.com/marklogic-community/newrelic-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marklogic-community%2Fnewrelic-plugin/sbom","scorecard":{"id":620180,"data":{"date":"2025-08-11","repo":{"name":"github.com/marklogic-community/newrelic-plugin","commit":"61bf437cace1c9d9b517e7ae2ad0022b8225086c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/2 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"project is archived","details":["Warn: Repository is archived."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 0.3.0 not signed: https://api.github.com/repos/marklogic-community/newrelic-plugin/releases/22470312","Warn: release artifact 0.3.0 does not have provenance: https://api.github.com/repos/marklogic-community/newrelic-plugin/releases/22470312"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 29 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-21T05:01:42.765Z","repository_id":52416852,"created_at":"2025-08-21T05:01:42.765Z","updated_at":"2025-08-21T05:01:42.765Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28414693,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T08:38:59.149Z","status":"ssl_error","status_checked_at":"2026-01-14T08:38:43.588Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["marklogic","monitoring","newrelic","plugin"],"created_at":"2026-01-14T08:47:12.837Z","updated_at":"2026-01-14T08:47:16.524Z","avatar_url":"https://github.com/marklogic-community.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"newrelic-marklogic-plugin is DEPRECATED\n=========================\n\n`New Relic Plugins are EOL \u003chttps://discuss.newrelic.com/t/new-relic-plugin-eol-wednesday-june-16th-2021/127267\u003e`_ and have been deprecated in favor of `New Relic Integrations \u003chttps://docs.newrelic.com/docs/integrations/\u003e`_. \n\n On Wednesday, June 16th, 2021, New Relic will no longer support or maintain Plugins 192. Any plugin that is currently in use should be replaced by the New Relic Infrastructure agent 166. Along with support and maintenance, we will be removing access to the current plugin pages on the New Relic One platform.\n\nThe `New Relic Flex agent \u003chttps://github.com/newrelic/nri-flex\u003e`_ is a recommended alternative to the newrelic-marklogic-plugin. There are `examples \u003chttps://github.com/newrelic/nri-flex/tree/master/examples\u003e`_ of YAML files demonstrating how to leverage the New Relic Flex agent to retrieve MarkLogic Manage API statistics and send to New Relic, similar to how the newrelic-marklogic-plugin used to. \n \n\n`NewRelic \u003chttp://www.newrelic.com\u003e`__ plugin for monitoring MarkLogic.\n########\n\nFeatures\n--------\n\n-  Easy to install\n-  Configurable selection of metrics to retrieve\n-  Retrieve summary metrics on local cluster, hosts, servers \u0026 forests\n-  Retrieve detail metrics on databases, forests, hosts, groups \u0026 servers\n-  Proxy access to NewRelic api\n-  Sample monitoring dashboards available at `NewRelic plugin central \u003chttps://newrelic.com/plugins\u003e`__.\n\nBefore you start\n----------------\n\n- Require minimally `Python 2.7.10  \u003chttps://www.python.org/\u003e`__ installed\n- `Requests python package \u003chttps://pypi.python.org/pypi/requests\u003e`__ v2.11 or greater\n- Require minimally `MarkLogic v7.0-6 \u003chttp://developer.marklogic.com/products\u003e`__ installed and running\n- Require `New Relic \u003chttp://www.newrelic.com/\u003e`__ account\n\nDocs\n----\n\n- `newrelic-marklogic-plugin docs on github \u003chttps://github.com/marklogic-community/newrelic-plugin\u003e`__\n- `newrelic-marklogic-plugin docs on pypi \u003chttps://pypi.python.org/pypi/newrelic-marklogic-plugin\u003e`__\n\nInstall, configure \u0026 run\n------------------------\n\nInstall the plugin using any of the following methods.\n\n- install from pypi repository:\n\n  ``pip install newrelic-marklogic-plugin``\n\n- install direct from GitHub:\n\n  ``pip install https://github.com/marklogic-community/newrelic-plugin/archive/master.zip``\n\n- download `release \u003chttps://github.com/marklogic-community/newrelic-plugin/releases\u003e`__  (or clone) repository and run the following:\n\n  ``python setup.py install``\n\n\nNext step is to create and edit configuration file.\n\n1) Copy\n   `etc/newrelic\\_marklogic.conf.sample \u003chttps://github.com/marklogic-community/newrelic-plugin/blob/master/etc/newrelic_marklogic.conf.sample\u003e`__\n   and to ``newrelic_marklogic.conf``\n\n2) Edit ``newrelic_marklogic.conf`` ensuring correct MarkLogic\n   connection details and NewRelic license key\n\nStart reporting metrics to NewRelic by running the following:\n\n``newrelic_marklogic.py -c newrelic_marklogic.conf``\n\nWhich samples metrics every period of length duration as set within configuration.\n\nIt is recommended to initiate plugin as a background task, run via a scheduler (ex. cron job) or using any other\napproach appropriate for your environment.\n\nRunning with -h flag will emit usage instructions for running plugin:\n\n``newrelic_marklogic.py -h``\n\n::\n\n    usage: ./newrelic_marklogic.py [-h] [-c config file] [-l log file]\n\n    -h print usage instructions  (this message)\n    -c config file               (default: newrelic_marklogic.conf)\n    -l log file                  (default: newrelic_marklogic.log)\n\nUsage\n-----\n\nThe configuration file drives all newrelic-marklogic-plugin features and is split into several sections.\n\nThe 'marklogic' section contains connection details to MarkLogic server and Management REST API.\n\n::\n\n    [marklogic]\n\n    # Scheme to use when accessing MarkLogic management REST API (http|https).\n    scheme = http\n\n    # Host to use when accessing MarkLogic management REST API (FQDN hostname).\n    host = localhost\n\n    # Port to use when accessing MarkLogic management REST API.\n    port = 8002\n\n    # Authentication to use when accessing MarkLogic management REST API (BASIC|DIGEST).\n    auth= DIGEST\n\n    # Username to use when accessing MarkLogic management REST API.\n    user = admin\n\n    # Password to use when accessing MarkLogic management REST API.\n    pass = admin\n\n    # (optional) Either a boolean, in which case it controls whether we verify\n    # the server's TLS certificate, or a string, in which case it must be a path\n    # to a CA bundle to use. Defaults to ``False``.\n    verify = False\n\nThe 'newrelic' section specifies the New Relic license key. Optionally you may nominate a proxy for accessing the New Relic Plugin API.\n\n::\n\n    [newrelic]\n\n    # Your NewRelic license key.\n    key = ****************************************\n\n    # Proxy (ex. http://10.10.1.10:3128).\n    http_proxy =\n\nThe 'plugin' section defines sample period for updating New Relic, as well as the logging level for emitting messages about plugin operation.\n\nThere are a set of configurations for defining which statuses are captured by New Relic, summarized below.\n\n- **summary_status** (True|False): retrieve local cluster summary status.\n- **databases** (list of databases): retrieve database detailed status.\n- **hosts_summary_status** (True|False):  retrieve summary of all hosts status.\n- **hosts** (list of hosts): retrieve host detailed status.\n- **forests_summary_status** (True|False): retrieve summary of all forests status.\n- **forests** (list of forests): retrieve forest detailed status.\n- **groups** (list of groups): retrieve group detailed status.\n- **servers_summary_status** (True|False): retrieve summary of all servers status.\n- **servers** (list of servers): retrieve server detailed status.\n\n::\n\n    [plugin]\n\n    # New Relic plugin display name.\n    name = myMarkLogicServer\n\n    # Unique New Relic plugin guid.\n    guid = com.marklogic\n\n    # Sample period in seconds.\n    duration = 60\n\n    # Set logging level (INFO|DEBUG|ERROR).\n    log_level = DEBUG\n\n    # Local cluster summary.\n    summary_status = False\n\n    # Database(s) detail status.\n    databases = Documents\n\n    # Hosts summary.\n    hosts_summary_status = True\n\n    # Host(s) detail status.\n    hosts = 127.0.0.1\n\n    # Forests summary.\n    forests_summary_status = True\n\n    # Forest(s) detail status.\n    forests = Documents Meters\n\n    # Group(s) detail status.\n    groups = Default\n\n    # Servers summary.\n    servers_summary_status = True\n\n    # Server(s) detail status (must supply group name ex. ServerName:GroupName).\n    servers = Manage:Default\n\nCreate pypi distribution\n---------------------------------------\n\n1. To create an official distribution, first ensure that all tests are passing:\n\n   ``python -m unittest discover -s tests``\n\n2. bump version number and create a distro:\n\n   ``python setup.py sdist``\n\n3. Upload the package to pypitest:\n\n   ``twine upload --repository-url https://test.pypi.org/legacy/ dist/*``\n\n4. after verifying all is well, generate the distro on pypi:\n\n   ``twine upload dist/*``\n\nIssues, feature requests \u0026 contributing\n---------------------------------------\n\nPlease file `bug reports \u003chttps://github.com/marklogic-community/newrelic-plugin/issues\u003e`__, `feature\nrequests \u003chttps://github.com/marklogic-community/newrelic-plugin/issues\u003e`__, and contribute with `pull\nrequests \u003chttps://github.com/marklogic-community/newrelic-plugin/pulls\u003e`__ through GitHub.\n\nCopyright \u0026 License\n-------------------\n\nnewrelic-marklogic-plugin Copyright 2019 MarkLogic Corporation\n\nnewrelic-marklogic-plugin is licensed under the Apache License, Version 2.0 (the \"License\"). A copy of the license is included within this package.\n\n`Apache License v2.0 \u003chttps://github.com/marklogic-community/newrelic-plugin/blob/master/LICENSE\u003e`__\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarklogic-community%2Fnewrelic-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarklogic-community%2Fnewrelic-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarklogic-community%2Fnewrelic-plugin/lists"}