feat(schema): wire proto-generated types into packageLogs.ts

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

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
68/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Quiet
Tech stack
typescript
Domain
backend

Research direction

Start by reading packageLogs.ts, the generated types in log_pb.ts, and the TODO in types.d.ts. Trace how current log objects and buildAttrs() are assembled, then verify that the new output follows the proto field names and nested metadata shape while HttpLegacyJsonExporter still preserves the v2.x format.

Written by the indexing model from the issue text.

Description

enhancement Userale

Summary

Replace the untyped Logging.Log = JSONObject with proto-generated types (RawLog, IntervalLog, CustomLog) from log_pb.ts in packageLogs.ts.

Breaking Changes

This changes the default JSON output format:

  • Fields restructured to match proto schema (nested metadata object)
  • Field renames: typeeventType, scrnResscreenResolution
  • buildAttrs() stops JSON.parse()-ing attribute values (always strings)
  • logType values may change (rawLOG_TYPE_RAW)

Migration Path

  • HttpLegacyJsonExporter preserves v2.x JSON format
  • Users can opt into legacy format via exporterType: 'http-json-legacy'

Depends On

  • #105 (proto schema — merged)
  • #139 (LogExporter interface)

Related

  • Resolves the TODO on line 77 of types.d.ts: // TODO: Switch to protobuf for managing log types
Dominant language
Jupyter Notebook
Stars
30
Forks
15
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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 apache/flagon

All issues in apache/flagon

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.