{"id":42045836,"url":"https://github.com/vast-data/vast-exporter","last_synced_at":"2026-01-26T06:09:31.846Z","repository":{"id":62465384,"uuid":"481718558","full_name":"vast-data/vast-exporter","owner":"vast-data","description":"VAST Prometheus Exporter","archived":false,"fork":false,"pushed_at":"2025-04-06T12:15:20.000Z","size":116,"stargazers_count":15,"open_issues_count":2,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-09-25T19:51:31.318Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/vast-data.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-14T19:01:51.000Z","updated_at":"2025-06-29T22:03:39.000Z","dependencies_parsed_at":"2023-12-17T12:27:21.474Z","dependency_job_id":"5c4eefb1-6642-45a5-821f-351ed4013e86","html_url":"https://github.com/vast-data/vast-exporter","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/vast-data/vast-exporter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vast-data%2Fvast-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vast-data%2Fvast-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vast-data%2Fvast-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vast-data%2Fvast-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vast-data","download_url":"https://codeload.github.com/vast-data/vast-exporter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vast-data%2Fvast-exporter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28768076,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T03:54:34.369Z","status":"ssl_error","status_checked_at":"2026-01-26T03:54:33.031Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":[],"created_at":"2026-01-26T06:09:30.946Z","updated_at":"2026-01-26T06:09:31.839Z","avatar_url":"https://github.com/vast-data.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"**_NOTE:_**  VAST versions 4.5 and later include the Prometheus Exporter as part\nof the official VMS API and it should be used instead of this external exporter.\nMore information is available on the VAST support site for versions\n[4.6](https://support.vastdata.com/s/article/UUID-1bdaad7b-b233-1cca-2df8-1e2a65069840),\n[4.7](https://support.vastdata.com/s/article/UUID-c408e47b-3144-8b19-b861-b1c54a728a45), \n[5.0](https://support.vastdata.com/s/article/UUID-07ca9adf-ea3a-ff7f-ca2d-c71aefc5a4db),\nand [5.1](https://support.vastdata.com/s/article/UUID-3678bd47-6b4d-934b-f0a2-2affe335bc52).\n\n---\n\nVAST Prometheus Exporter\n========================\n\nThe Prometheus exporter connects to VMS and leverages its REST API to extract state and metric information.\nIt listens to port 8000 by default. This can be changed using the `--port` parameter.\n\nPre-requisities\n---------------\n\nVAST versions 4.2 to 4.4.\n\n_VAST versions \u003e= 4.5 should use the exporter included with VMS._\n\nMetrics Provided\n----------------\n\n1. Cluster capacity and states.\n2. Physical component states (NIC, node, drive, etc').\n3. Logical objects: view, quota, replication targets, etc'.\n4. Performance metrics (BW/IOPS/latency/etc') for cluster, nodes, views and top users.\n\nDocker Installation\n-------------------\n\n    # build a local docker image\n    $ ./build.sh\n    # run a docker container in the background\n    $ ./run.sh --user=\u003cUSER\u003e --password=\u003cPASSWORD\u003e --address=\u003cADDRESS\u003e\n\nPython Installation\n-------------------\n\n    $ pip install -r requirements.txt\n    $ ./vast_exporter.py --user=\u003cUSER\u003e --password=\u003cPASSWORD\u003e --address=\u003cADDRESS\u003e\n\n\nUsage\n-----\n\nBeyond the user/password/address parameters which are required there are optional parameters.\nOptional features inlude specifying a custom SSL certificate and collection of top user performance data.\nRun the exporter with --help to see a description.\n\nTesting\n-------\n\nTo run the exporter once and make sure no errors are raised run the following:\n\n    $ ./vast_exporter.py --user=\u003cUSER\u003e --password=\u003cPASSWORD\u003e --address=\u003cADDRESS\u003e --test\n    2022-04-28 11:36:47,045 MainThread INFO: VAST Exporter started running. Listening on port 8001\n    2022-04-28 11:36:58,658 MainThread INFO: Collection is successful!\n\nTo run the exporter forever remove the --test parameter and get the output using curl:\n\n    $ curl http://localhost:8000 | grep vast_collector\n    # HELP vast_collector_latency Total collection time\n    # TYPE vast_collector_latency summary\n    vast_collector_latency_count 1.0\n    vast_collector_latency_sum 7.011876339\n    ...\n\n\nMonitoring\n----------\n\nBesides the obious stdout output where errors will land, the following metric will be incremeneted upon an error:\n\n    vast_collector_errors_total\n\nPrometheus Config\n-----------------\n\nFull explanation of Prometheus configuration here: https://prometheus.io/docs/prometheus/latest/configuration/configuration/\n\nThe following snippet shows how to add the VAST exporter to Prometheus:\n\n    # A scrape configuration containing exactly one endpoint to scrape:\n    # Here it's Prometheus itself.\n    scrape_configs:\n      # The job name is added as a label `job=\u003cjob_name\u003e` to any timeseries scraped from this config.\n      - job_name: \"vast\"\n\n        # metrics_path defaults to '/metrics'\n        # scheme defaults to 'http'.\n        scrape_interval: 1m\n        scrape_timeout: 50s\n        \n        static_configs:\n          - targets: [\"\u003cEXPORTER HOST\u003e:8000\"]\n\nHow to run Prometheus using docker:\n\n    docker run -p 9090:9090 -v /path/to/prometheus.yml:/etc/prometheus/prometheus.yml prom/prometheus\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvast-data%2Fvast-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvast-data%2Fvast-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvast-data%2Fvast-exporter/lists"}