Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/additional metrics #19

Merged
merged 8 commits into from
Jul 3, 2024
Merged

Feature/additional metrics #19

merged 8 commits into from
Jul 3, 2024

Conversation

luissimas
Copy link
Owner

@luissimas luissimas commented Jun 26, 2024

Enhance metrics collection. The initial plan was to implement the following features:

  1. Check if target is a markdown file
  2. Collect word count
  3. Collect time to read
  4. Exclude links to non existing files
  5. Collect backlinks

All features were implemented except for 3 and 4. Time to read can be inferred from word count at query time, giving users more flexibility to use the metrics. Excluding links to non existing files seems a bit too implicit, but it may be added in the future with a configurable option.

The new metrics are now included in the dashboard, producing the following result:

image

Closes #8.

@luissimas luissimas self-assigned this Jun 26, 2024
@codecov-commenter
Copy link

codecov-commenter commented Jun 26, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 72.83951% with 22 lines in your changes missing coverage. Please review.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Files Coverage Δ
internal/collector/note.go 95.83% <100.00%> (+8.33%) ⬆️
internal/zettelkasten/git.go 7.40% <ø> (ø)
internal/collector/collector.go 63.79% <94.73%> (+8.69%) ⬆️
internal/storage/fake.go 40.00% <0.00%> (ø)
internal/storage/influxdb.go 0.00% <0.00%> (ø)

@luissimas luissimas force-pushed the feature/additional-metrics branch 2 times, most recently from 717b0a7 to 961e78e Compare July 2, 2024 10:08
@luissimas luissimas force-pushed the feature/additional-metrics branch from 961e78e to 110931f Compare July 2, 2024 10:14
Adds support for collecting backlinks. For simplification we now assume
that all notes have unique base file names.
@luissimas luissimas force-pushed the feature/additional-metrics branch from c729c46 to 24ae10c Compare July 2, 2024 12:12
@luissimas luissimas force-pushed the feature/additional-metrics branch from 24ae10c to 2dbf3ae Compare July 2, 2024 12:17
@luissimas luissimas force-pushed the feature/additional-metrics branch from 5f845a8 to 91e88d6 Compare July 3, 2024 11:49
@luissimas luissimas marked this pull request as ready for review July 3, 2024 12:13
@luissimas luissimas merged commit a7e8afb into main Jul 3, 2024
5 checks passed
@luissimas luissimas deleted the feature/additional-metrics branch July 3, 2024 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhance metrics collection
2 participants