Metrics endpoint

[Malakan]

Hi,

I’ve been making a little Gramps Web exporter using API documentation I found here: Swagger UI

Wondering if GrampsWeb has the option to have a metrics endpoint enabled for prometheus to scrape so I can view the details within grafana. This would remove the need for my exporter but simplify the overall workflow. I can’t find any documentation on this other than the telemetry data sent once a day.

A little bug perhaps, the get metadata API call does not return the Gramps Web Frontend version number. Is this value stored/returned elsewhere?

Thanks!

Malakan

[emyoulation]

• Swagger UI – An open-source tool for visualizing and interacting with RESTful APIs, allowing developers to browse API documentation and test endpoints with a user-friendly interface.
  More info: Swagger Tutorial: What is Swagger UI and How to Use Swagger
• Prometheus – an open-source metrics and monitoring system. Prometheus Monitoring 101 - A Beginner's Guide | SigNoz
• Grafana – an open-source visualization and analytics platform. What is Grafana?

[DavidMStraub]

@Malakan

I’ve been making a little Gramps Web exporter using API documentation I found here: Swagger UI

Mind sharing it?

@Malakan

Wondering if GrampsWeb has the option to have a metrics endpoint enabled for prometheus to scrape so I can view the details within grafana. This would remove the need for my exporter but simplify the overall workflow. I can’t find any documentation on this other than the telemetry data sent once a day.

No. In my view this should be handled outside of Gramps Web API.

@Malakan

A little bug perhaps, the get metadata API call does not return the Gramps Web Frontend version number. Is this value stored/returned elsewhere?

Not a bug. The Web API can be used without a frontend, or even with different versions of the frontend. So it doesn’t know the frontend version.

The frontend exposes its own version in the `grampsjs-sysinfo` component.

[Malakan]

Appologies for the delay, this is my first time building and sharing an image, had to setup some things.

Here’s my first iteration:

docker pull ghcr.io/supermalakan/grampsweb_exporter:latest

services:
  grampsweb_exporter:
    image: ghcr.io/supermalakan/grampsweb_exporter:latest
    container_name: grampsweb_exporter
    restart: unless-stopped
    ports:
      - "8000:8000"
    environment:
      GRAMPSWEB_URL: “https://demo.grampsweb.org/” # Change to your Gramps Web URL
      GRAMPSWEB_USER: “owner” # Change to your Gramps Web username
      GRAMPSWEB_PASS: “owner” # Change to your Gramps Web password
      SCRAPE_INTERVAL: 120 # Scrape interval in seconds (default: 120)

I was going to put in the grampsweb demo details into the readme, if that’s fine with you?

The only thing this scrapes so far is from the metadata API call: gramps.version, gramps_ql.version, gramps_webapi.version, gramps_webapi.schema and finally object_counts.

If there any other metrics you would like, let me know! Feedback welcome!

Grafana showing the scraped data