🚨 Jira Linter Failed

Commit: 80dc4bc
Failed at: 2026-05-05 15:36:58 UTC

The Jira linter failed to validate your PR. Please check the error details below:

failed to get Jira issue: failed to fetch Jira issue TT-13727: Issue does not exist or you do not have permission to see it.: request failed. Please analyze the request body for more details. Status code: 404

Next Steps

• Ensure your branch name contains a valid Jira ticket ID (e.g., ABC-123)
• Verify your PR title matches the branch's Jira ticket ID
• Check that the Jira ticket exists and is accessible

This comment will be automatically deleted once the linter passes.

This PR introduces a new configuration option for log formatting to standardize gateway application log timestamps, making them RFC3339 compliant by default.

Files Changed Analysis

The changes introduce a new log_format option with three possible values: text (default), json, and legacy.

• log/log.go & log/log_test.go: This is the core of the change. It refactors the logging formatter logic to support different timestamp formats. A new SetupFormatter function centralizes the configuration of both the Tyk logger and the global logrus logger. The text and json formats use RFC3339 timestamps, while the legacy format retains the old timestamp style for backward compatibility. Extensive tests have been added to validate the new behavior.
• config/config.go: The Config struct is updated to include the new LogFormat field, changing its type from string to a new logger.Format type.
• cli/linter/schema.json: The JSON schema for the configuration is updated to reflect the new allowed values for log_format.
• gateway/server.go: The gateway initialization logic is updated to call the new tyklog.SetupFormatter function, applying the configured log format at startup.
• certs/manager.go: Updated to use the centralized tyklog.Get() logger instead of instantiating a new one, promoting consistency.
• gateway/host_checker_manager.go: Minor import reordering.

Architecture & Impact Assessment

• What this PR accomplishes: It provides a mechanism to control the timestamp format in application logs. By defaulting to RFC3339, it enhances consistency and makes logs easier to parse for modern observability tools. The legacy option ensures a non-breaking change for users who rely on the previous format.

• Key technical changes introduced:

  • A new configuration option, log_format, is added.
  • The logging package is refactored to introduce explicit formatters for text, json, and legacy outputs.
  • A centralized function, log.SetupFormatter, is created to apply the chosen format globally during gateway initialization.

• Affected system components: The primary impact is on the Logging Subsystem and Configuration Management. All logs generated by the gateway will be affected by this change, ensuring a consistent output format across the application.

Log Formatting Flow

graph TD
    subgraph sg1 [Configuration]
        A[tyk.conf: log_format] --> B[config.go: Config.LogFormat]
    end
    subgraph sg2 [Gateway Initialization]
        B --> C["gateway/server.go: initSystem()"]
        C --> D["log/log.go: SetupFormatter(format)"]
    end
    subgraph sg3 [Logging Subsystem]
        D --> E{Switch on format}
        E --|text or default|--> F[Create TextFormatter with RFC3339]
        E --|json|--> G[Create JSONFormatter with RFC3339]
        E --|legacy|--> H[Create TextFormatter with legacy format]
        F --> I[Set tyk logger & global logrus formatter]
        G --> I
        H --> J[Set tyk logger formatter ONLY]
    end

Scope Discovery & Context Expansion

The changes are well-contained within the logging and configuration initialization paths. The refactoring in certs/manager.go to use tyklog.Get() is a positive step towards standardizing how logger instances are obtained throughout the codebase.

Further work could involve auditing the repository for any other direct instantiations of logrus.New() and replacing them with the centralized tyklog.Get() to ensure all application logs adhere to the configured format.

Powered by Visor from Probelabs

Last updated: 2026-05-05T15:38:59.193Z | Triggered by: pr_opened | Commit: 80dc4bc

💡 TIP: You can chat with Visor using /visor ask <your question>

Architecture Issues (1)

Architecture Issues (1)

No performance issues found – changes LGTM.

Quality Issues (2)

	// non legacy formatter also sets up global logrus formatter

Powered by Visor from Probelabs

Last updated: 2026-05-05T15:38:41.725Z | Triggered by: pr_opened | Commit: 80dc4bc

💡 TIP: You can chat with Visor using /visor ask <your question>

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud