schaermu/changedetection.io-exporter

A prometheus-compatible exporter for your changedetection.io instance.

changedetection.io-exporter's Issues

Log entries created from user inputs

Tracking issue for:

• https://github.com/schaermu/changedetection.io-exporter/security/code-scanning/3 (internal/testutil/api_helpers.go:92)
• https://github.com/schaermu/changedetection.io-exporter/security/code-scanning/2 (internal/testutil/api_helpers.go:76)

Add system metrics

Expose information from /api/v1/systeminfo as changedetectionio_system_xxx:

{
    'queue_size': 10 ,
    'overdue_watches': ["watch-uuid-list"],
    'uptime': 38344.55,
    'watch_count': 800,
    'version': "0.40.1"
}

error while fetching watches: json: cannot unmarshal string into Go struct field WatchItem.last_error of type bool

changedetection-exporter | time="2024-04-19 03:49:54.484583" level=error msg="error while fetching watches: json: cannot unmarshal string into Go struct field WatchItem.last_error of type bool"****

cicd: upgrade actions setup-go and checkout

Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions/setup-go@v2, actions/checkout@v2. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.

Add documentation

Add more information to README.md:

• Description
• Features
• Installation/Setup
• Contributing
• ...

cant get metrics of watch

env:
changedetection 0.45.26

i get metrics like this
i have 29 watch and i cant get any metrics of watch like ‘changedetectionio_watch_fetch_time’

# HELP changedetectionio_system_overdue_watch_count Current changedetection.io instance overdue watch count
# TYPE changedetectionio_system_overdue_watch_count gauge
changedetectionio_system_overdue_watch_count{version="0.45.26"} 0
# HELP changedetectionio_system_queue_size Current changedetection.io instance queue size
# TYPE changedetectionio_system_queue_size gauge
changedetectionio_system_queue_size{version="0.45.26"} 0
# HELP changedetectionio_system_uptime Current changedetection.io instance system uptime
# TYPE changedetectionio_system_uptime gauge
changedetectionio_system_uptime{version="0.45.26"} 1.1108097e+06
# HELP changedetectionio_system_watch_count Current changedetection.io instance watch count
# TYPE changedetectionio_system_watch_count gauge
changedetectionio_system_watch_count{version="0.45.26"} 29
# HELP go_gc_duration_seconds A summary of the pause duration of garbage collection cycles.
# TYPE go_gc_duration_seconds summary
go_gc_duration_seconds{quantile="0"} 4.647e-05
go_gc_duration_seconds{quantile="0.25"} 6.632e-05
go_gc_duration_seconds{quantile="0.5"} 7.708e-05
go_gc_duration_seconds{quantile="0.75"} 8.75e-05
go_gc_duration_seconds{quantile="1"} 0.00011919
go_gc_duration_seconds_sum 0.005171748
go_gc_duration_seconds_count 67
# HELP go_goroutines Number of goroutines that currently exist.
# TYPE go_goroutines gauge
go_goroutines 33
# HELP go_info Information about the Go environment.
# TYPE go_info gauge
go_info{version="go1.22.2"} 1
# HELP go_memstats_alloc_bytes Number of bytes allocated and still in use.
# TYPE go_memstats_alloc_bytes gauge
go_memstats_alloc_bytes 1.284288e+06
# HELP go_memstats_alloc_bytes_total Total number of bytes allocated, even if freed.
# TYPE go_memstats_alloc_bytes_total counter
go_memstats_alloc_bytes_total 1.1702536e+07
# HELP go_memstats_buck_hash_sys_bytes Number of bytes used by the profiling bucket hash table.
# TYPE go_memstats_buck_hash_sys_bytes gauge
go_memstats_buck_hash_sys_bytes 7674
# HELP go_memstats_frees_total Total number of frees.
# TYPE go_memstats_frees_total counter
go_memstats_frees_total 22641
# HELP go_memstats_gc_sys_bytes Number of bytes used for garbage collection system metadata.
# TYPE go_memstats_gc_sys_bytes gauge
go_memstats_gc_sys_bytes 2.678472e+06
# HELP go_memstats_heap_alloc_bytes Number of heap bytes allocated and still in use.
# TYPE go_memstats_heap_alloc_bytes gauge
go_memstats_heap_alloc_bytes 1.284288e+06
# HELP go_memstats_heap_idle_bytes Number of heap bytes waiting to be used.
# TYPE go_memstats_heap_idle_bytes gauge
go_memstats_heap_idle_bytes 4.947968e+06
# HELP go_memstats_heap_inuse_bytes Number of heap bytes that are in use.
# TYPE go_memstats_heap_inuse_bytes gauge
go_memstats_heap_inuse_bytes 2.70336e+06
# HELP go_memstats_heap_objects Number of allocated objects.
# TYPE go_memstats_heap_objects gauge
go_memstats_heap_objects 2162
# HELP go_memstats_heap_released_bytes Number of heap bytes released to OS.
# TYPE go_memstats_heap_released_bytes gauge
go_memstats_heap_released_bytes 2.408448e+06
# HELP go_memstats_heap_sys_bytes Number of heap bytes obtained from system.
# TYPE go_memstats_heap_sys_bytes gauge
go_memstats_heap_sys_bytes 7.651328e+06
# HELP go_memstats_last_gc_time_seconds Number of seconds since 1970 of last garbage collection.
# TYPE go_memstats_last_gc_time_seconds gauge
go_memstats_last_gc_time_seconds 1.7230937478211102e+09
# HELP go_memstats_lookups_total Total number of pointer lookups.
# TYPE go_memstats_lookups_total counter
go_memstats_lookups_total 0
# HELP go_memstats_mallocs_total Total number of mallocs.
# TYPE go_memstats_mallocs_total counter
go_memstats_mallocs_total 24803
# HELP go_memstats_mcache_inuse_bytes Number of bytes in use by mcache structures.
# TYPE go_memstats_mcache_inuse_bytes gauge
go_memstats_mcache_inuse_bytes 4800
# HELP go_memstats_mcache_sys_bytes Number of bytes used for mcache structures obtained from system.
# TYPE go_memstats_mcache_sys_bytes gauge
go_memstats_mcache_sys_bytes 15600
# HELP go_memstats_mspan_inuse_bytes Number of bytes in use by mspan structures.
# TYPE go_memstats_mspan_inuse_bytes gauge
go_memstats_mspan_inuse_bytes 85280
# HELP go_memstats_mspan_sys_bytes Number of bytes used for mspan structures obtained from system.
# TYPE go_memstats_mspan_sys_bytes gauge
go_memstats_mspan_sys_bytes 97920
# HELP go_memstats_next_gc_bytes Number of heap bytes when next garbage collection will take place.
# TYPE go_memstats_next_gc_bytes gauge
go_memstats_next_gc_bytes 4.194304e+06
# HELP go_memstats_other_sys_bytes Number of bytes used for other system allocations.
# TYPE go_memstats_other_sys_bytes gauge
go_memstats_other_sys_bytes 844766
# HELP go_memstats_stack_inuse_bytes Number of bytes in use by the stack allocator.
# TYPE go_memstats_stack_inuse_bytes gauge
go_memstats_stack_inuse_bytes 720896
# HELP go_memstats_stack_sys_bytes Number of bytes obtained from system for stack allocator.
# TYPE go_memstats_stack_sys_bytes gauge
go_memstats_stack_sys_bytes 720896
# HELP go_memstats_sys_bytes Number of bytes obtained from system.
# TYPE go_memstats_sys_bytes gauge
go_memstats_sys_bytes 1.2016656e+07
# HELP go_threads Number of OS threads created.
# TYPE go_threads gauge
go_threads 7
# HELP process_cpu_seconds_total Total user and system CPU time spent in seconds.
# TYPE process_cpu_seconds_total counter
process_cpu_seconds_total 0.21
# HELP process_max_fds Maximum number of open file descriptors.
# TYPE process_max_fds gauge
process_max_fds 1.048576e+06
# HELP process_open_fds Number of open file descriptors.
# TYPE process_open_fds gauge
process_open_fds 22
# HELP process_resident_memory_bytes Resident memory size in bytes.
# TYPE process_resident_memory_bytes gauge
process_resident_memory_bytes 1.3893632e+07
# HELP process_start_time_seconds Start time of the process since unix epoch in seconds.
# TYPE process_start_time_seconds gauge
process_start_time_seconds 1.72308599868e+09
# HELP process_virtual_memory_bytes Virtual memory size in bytes.
# TYPE process_virtual_memory_bytes gauge
process_virtual_memory_bytes 1.2630016e+09
# HELP process_virtual_memory_max_bytes Maximum amount of virtual memory available in bytes.
# TYPE process_virtual_memory_max_bytes gauge
process_virtual_memory_max_bytes 1.8446744073709552e+19

Extend CI/CD pipeline

• Add CodeQL
• Implement testing workflow (depends on #5)
• pre-commit hooks for linting (conventional-commits & golint)

Fix CollectAndCount bug when testing watch metrics

changedetection.io-exporter/pkg/collectors/watch_collector_test.go

Line 29 in d5f3303

//testutil.ExpectMetricCount(t, c, 2, expectedWatchMetrics...)

Adding Metric for last change data

Hey there,

mit would be cool to have data like what changed on each check. So basically what a Notification would include with changed parts.

I’m not familiar with the Changedetection API but maybe this Entrypoint would be fitting to receive the Data: https://changedetection.io/docs/api_v1/index.html#api-Watch_History-Get_single_snapshot_content

Add scraper metrics for all watches

Collect infomation from /api/v1/watch/{id}, relevant properties are:

• check_count
• fetch_time
• notification_alert_count
• last_check_status

Expose as changedetectionio_watch_xxx with label title. More labels are implemented with #15.

• Implement new watchCollector struct
• Implement watch details endpoint on ApiClient at /api/v1/watch/{id}.
• Expose relevant properties as metrics
• Extract test fixtures & implement tests for all metrics

Add more labels to price & scrape metrics

Beside title we should add more labels to guarantee uniqueness across metrics:

• uuid - unique identifier for each watch
• source - the host part of the watch's URL
• …

This issue depends on #2 to be implemented.

• Refactor label generation to be centralized and re-usable
• Add UUID as label
• Implement source extraction
• Add source as label
• Add test to verify labels on metrics
• Adopt metric fixtures

Fix tests for automatic registration/deregistration of metrics

The exporter should automatically pick up newly created or removed watches within the monitored changedetection.io instance without having to restart.

This behavior does not seem to work properly (or at least the tests fail), this is why TestAutoUnregisterCollector and TestAutoregisterPriceCollector are commented out.

Add unit tests

Implement unit tests (see https://github.com/prometheus/haproxy_exporter/blob/main/haproxy_exporter_test.go)

Missing error check

Tracking issue for:

• https://github.com/schaermu/changedetection.io-exporter/security/code-scanning/1 (pkg/cdio/api.go:68)