Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Centralize API v1 observability in Google Cloud

Open
#3,847 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
flask, google-cloud, python

Research direction

Start at Flask API v1 application construction and follow the simulation dispatch path to understand the request lifecycle and correlation metadata flow. Then inspect the production and staging deployment configuration for service identity, environment, collector destination, and credentials; done means the stated acceptance checks pass without changing API responses or calculation behavior.

Written by the indexing model from the issue text.

Description

Summary

Integrate the Flask API v1 service with policyengine-observability 2.0 so requests produce centralized structured logs, traces, and bounded metrics in the policyengine-observability Google Cloud project.

Scope

  • Configure an explicitly owned observability runtime during application construction.
  • Instrument the Flask request lifecycle without route decorators.
  • Propagate W3C trace context and X-PolicyEngine-Request-Id through the API v1 simulation dispatch path.
  • Configure production and staging service identity, deployment environment, collector destination, and workload credentials.
  • Prove API responses remain unchanged when observability setup or export fails.
  • Preserve existing API contracts and calculation behavior.

Acceptance criteria

  • API v1 request completion records use the version 2 schema.
  • Simulation dispatch carries allowlisted correlation metadata only.
  • Observability failures do not change successful responses or application exceptions.
  • Production and staging deploy configuration names only the approved Cloud Run services and central destination.
  • Relevant formatting, lint, unit, and contract checks pass.
Dominant language
Python
Stars
18
Forks
33
Avg merge
1d 3h
Merged PRs (30d)
23

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from PolicyEngine/policyengine-api

All issues in PolicyEngine/policyengine-api

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.