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

Migrate API v1 simulation services to centralized observability

Open
#685 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Active
Tech stack
google-cloud, python

Research direction

Start by locating the API v1 simulation entry, Modal gateway, executor, and batch workers named in the scope, then inspect their current Logfire and telemetry setup. Review the existing deployment configuration and service-level tests before changing the observability integration. Done means all participating services emit the version 2 schema, preserve allowlisted correlation metadata, contain no Logfire runtime path, and remain unaffected when telemetry fails.

Written by the indexing model from the issue text.

Description

Summary

Migrate the API v1 simulation entry, Modal gateway, executor, and batch workers to policyengine-observability 2.0 and central Google Cloud telemetry.

Scope

  • Replace version 1 global helpers with runtime-bound operations and spans.
  • Remove Logfire initialization, secrets, dependencies, and forced OpenTelemetry disablement.
  • Carry allowlisted request and trace correlation metadata from entry to gateway to worker.
  • Configure explicit service identity, environment, collector endpoint, Google project, and Workload Identity Federation credentials for approved API v1 applications.
  • Add service-level failure-isolation tests.
  • Keep other PolicyEngine applications outside this change.

Acceptance criteria

  • Each participating service emits the version 2 structured log schema.
  • Worker operations restore incoming correlation metadata without including simulation inputs or reform payloads.
  • No Logfire runtime path remains in these services.
  • Failed telemetry setup or export does not change simulation outcomes.
  • Relevant formatting, lint, unit, integration, and deployment configuration checks pass.
Dominant language
Python
Stars
1
Forks
1
Avg merge
15h 3m
Merged PRs (30d)
14

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-sim-api

All issues in PolicyEngine/policyengine-sim-api

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.