Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guicaulada/vscode-exporter
Prometheus exporter for VSCode metrics
https://github.com/guicaulada/vscode-exporter
Last synced: 2 months ago
JSON representation
Prometheus exporter for VSCode metrics
- Host: GitHub
- URL: https://github.com/guicaulada/vscode-exporter
- Owner: guicaulada
- License: agpl-3.0
- Created: 2022-09-25T06:05:11.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-24T16:55:24.000Z (over 1 year ago)
- Last Synced: 2024-11-02T02:50:17.354Z (3 months ago)
- Language: TypeScript
- Size: 318 KB
- Stars: 62
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# vscode-exporter
Prometheus exporter for VSCode metrics using [prom-client](https://github.com/siimon/prom-client).
[](https://guicaulada.grafana.net/public-dashboards/e00f2ad838544b02826e8c075c05df45?orgId=1&refresh=30s)
You can download the dashboard [here](https://grafana.com/grafana/dashboards/18169).
## Features
This extension exposes the following custom metrics on the `/metrics` endpoint:
```text
vscode_debug_seconds_total{id, name, type, folder} counter
vscode_debug_seconds_active{id, name, type, folder} counter
vscode_debug_sessions_active{id, name, type, folder} gauge
vscode_breakpoints_enabled{session id, name, type, folder} gauge
vscode_breakpoints_active{session id, name, type, folder} gauge
vscode_debug_custom_events{id, name, type, folder} counter
vscode_tasks_seconds_total{name, type, is_background} counter
vscode_tasks_active{name, type, is_background} gauge
vscode_tasks_process_active{name, type, is_background} gauge
vscode_tasks_process_total{name, type, is_background, exit_code} counter
vscode_notebooks_seconds_active{project, folder, file, type, is_untitled} counter
vscode_notebooks_cells{project, folder, file, type, is_untitled} gauge
vscode_terminals_seconds_total{name, exit_code} counter
vscode_terminals_seconds_active{name, exit_code} counter
vscode_terminals_active {name} gauge
vscode_editor_seconds_active{project, folder, file, language, is_untitled} counter
vscode_characters_total{project, folder, file, language, is_untitled} gauge
vscode_lines_total{project, folder, file, language, is_untitled} gauge
vscode_editors_edits_total{project, folder, file, language, is_untitled} counter
vscode_notebooks_edits_total{project, folder, file, language, is_untitled} counter
vscode_notebooks_visible{project, folder, file, type, is_untitled} gauge
vscode_editors_visible{project, folder, file, language, is_untitled} gauge
vscode_seconds_active {focused} counter
vscode_notebooks_content_changes_total{project, folder, file, type, is_untitled} counter
vscode_notebooks_cell_changes_total{project, folder, file, type, is_untitled} counter
vscode_editors_content_changes_total{project, folder, file, language, is_untitled} counter
vscode_workspace_folders_added{project, folder, name} counter
vscode_workspace_folders_removed{project, folder, name} counter
vscode_workspace_notebooks_closed{project, folder, file, type, is_untitled} counter
vscode_workspace_documents_closed{project, folder, file, language, is_untitled} counter
vscode_workspace_files_added{project, folder, name} counter
vscode_workspace_files_removed{project, folder, name} counter
vscode_workspace_trust_grants{project} counter
vscode_workspace_notebooks_opened{project, folder, file, type, is_untitled} counter
vscode_workspace_documents_opened{project, folder, file, language, is_untitled} counter
vscode_workspace_files_renamed{project, folder, name} counter
vscode_workspace_notebooks_saved{project, folder, file, type, is_untitled} counter
vscode_workspace_documents_saved{project, folder, file, language, is_untitled} counter
```
All the default metrics recommended by Prometheus [itself](https://prometheus.io/docs/instrumenting/writing_clientlibs/#standard-and-runtime-collectors) for Node.js are also exposed.
## Extension Settings
This extension contributes the following settings:
* `VSCodeExporter.port`: Port to expose metrics on (default: 9931).
* `VSCodeExporter.debug`: Enable debug logs (default: false).
## Extension Commands
This extension contributes the following commands:
* `vscode-exporter.open`: Opens the metrics endpoint on your browser.
**All recommendations, issues and pull requests are welcome! Enjoy!**