Implementation of Request Labeling via Headers for Granular Observability & Budgeting

[Neiko2002]

Description

I would like to propose a new Labeling System for GoModel. This feature would allow users to assign custom labels to incoming requests based on HTTP header information. These labels can then be used as a primary filter and grouping criterion across various admin and monitoring modules.

Problem Statement

Currently, tracking traffic in the Audit Logs or managing budgets is primarily tied to user_path or API keys. In complex environments where multiple applications (e.g., Staging vs. Production, or App-A/B Test) use the same gateway/path, it is difficult to differentiate and group the traffic for analysis or cost control without creating separate keys for every single instance.

Proposed Solution

1. Label Configuration (New Admin UI/API):

• A new menu item where users can define rules like:
• If Header X-App-ID equals Mobile-App-iOS, assign Label iOS.
• If Header X-App-Variant equals TypeA, assign Label TypeA.

2. Data Enrichment:

• GoModel should extract these headers during the request lifecycle and store the assigned label alongside the request metadata in the database (PostgreSQL/SQLite/MongoDB).

3. Integration across Modules:

• Audit Logs: Add a "Filter by Label" dropdown and a "Group by Label" view.
• Usage/Budgeting: Allow setting budget limits or viewing cost breakdowns specifically for a label.
• Failover Tests: Use labels to target specific traffic groups for testing.

Benefits

• Improved Observability: Better grouping in the dashboard and logs (maybe with different colors).
• Granular Budgeting: Monitor costs per application or department more easily.
• Flexibility: Can be used in several futures features.

[SantiagoDePolonia]

Thank you for this suggestion. I'll definitely implement something convenient for this use case.

For now, I've made the User-Path Header configurable: https://gomodel.enterpilot.io/docs/features/user-path#http-header
. This is available in GoModel v0.1.30.

It might work for your use case. Once you remove the User-Path from the API keys and rename the User-Path's header to X-App-ID, it should generate the appropriate paths. The first slash / will be added automatically in this case.

However, this isn’t perfect and it's not the final solution for this use case. I need to think it through and design it in a solid way. Stay tuned!

[Neiko2002]

Thank you. It took me a while to make API keys work. It would be good if the documentation and guides would include a section about API keys and what user pathes do in this context.