4665: Setup for Log v2 config

[matt-metivier]

🎯 Overview

Extends Terraform provider support for managing Asserts configurations through Grafana Cloud by adding resources for Custom Model Rules and Log Drilldown Environment Config. This implementation uses the existing integration with the Grafana Asserts App Plugin, leveraging Grafana Service Account authentication and stack-scoped API calls.

🚀 Features Added

Resources Implemented

• grafana_asserts_custom_model_rules — Manages custom model rule configurations.
• grafana_asserts_log_drilldown_config — Manages per-environment log drilldown configuration.

Authentication & Architecture

• ✅ Grafana Service Account Token authentication (no separate Asserts tokens needed)
• ✅ Stack-scoped API calls using X-Scope-OrgID headers
• ✅ Grafana Asserts App Plugin integration via plugin API gateway
• ✅ Updated generated API client from grafana-asserts-public-clients/go/gcom (repo)

🏗️ Architecture

API Flow:

Terraform Provider → Grafana Service Account Token → Grafana Asserts App Plugin → Asserts Backend

Plugin API Gateway Endpoints:

/api/plugins/grafana-asserts-app/resources/asserts/api-server/v1/config/model-rules
/api/plugins/grafana-asserts-app/resources/asserts/api-server/v1/config/environment
/api/plugins/grafana-asserts-app/resources/asserts/api-server/v1/config/environment/{name}

Key Implementation Details:

• Uses generated client github.com/grafana/grafana-asserts-public-clients/go/gcom (repo)
• API calls are routed through the Grafana plugin system; the plugin handles auth and forwards requests
• For log drilldown, uses updated DTOs: TenantEnvConfigResponseDto, EnvironmentDto, LogConfigDto

Headers Used:

• Authorization: Bearer {token}
• X-Scope-OrgID: {stackID}
• Content-Type: application/json

💻 Example Usage

// Custom Model Rules
resource "grafana_asserts_custom_model_rules" "test" {
  name = "test-anything"
  rules = <<-EOT
    entities:
    - type: Whatever
      name: Nothing
      definedBy:
      - query: "up{job=\\"nothing\\"}"
  EOT
}

// Log Drilldown Environment Config
resource "grafana_asserts_log_drilldown_config" "env_default" {
  name  = "default"
  # YAML for EnvironmentDto
  config = <<-YAML
    name: default
    defaultConfig: true
    logConfig:
      tool: "loki"
      dataSource: "Loki"
      correlationLabels: "traceID, spanID"
      labelToLogFieldMapping:
        service: "service"
        namespace: "namespace"
  YAML
}

Import for Log Drilldown Config:

terraform import grafana_asserts_log_drilldown_config.name "<environment_name>"

📁 Files Added/Modified

New Files

• internal/resources/asserts/resource_log_drilldown_config.go — Log Drilldown Environment Config resource (CRUD via LogConfigControllerAPI)

• internal/resources/asserts/resource_log_drilldown_config_test.go — Acceptance tests (create/update/read/delete/import)

• examples/resources/grafana_asserts_log_drilldown_config/resource.tf — Example usage

• examples/resources/grafana_asserts_log_drilldown_config/import.sh — Import helper

• docs/resources/asserts_log_drilldown_config.md — Generated documentation

• internal/resources/asserts/resource_custom_model_rules.go — Custom Model Rules resource

• internal/resources/asserts/resource_custom_model_rules_test.go — Acceptance tests

• examples/resources/grafana_asserts_custom_model_rules/resource.tf — Example usage

• docs/resources/asserts_custom_model_rules.md — Generated documentation

Modified Files

• internal/resources/asserts/resources.go — Registered new resource
• internal/resources/asserts/catalog-resource.yaml — Added Backstage catalog entries
• go.mod / go.sum — Bumped grafana-asserts-public-clients/go/gcom to latest with updated DTOs and endpoints
• Documentation site regenerated (go generate ./...)

Test Categories

• ✅ Resource schema validation
• ✅ CRUD operations (Create, Read, Update, Delete)
• ✅ Import functionality
• ✅ Error handling and diagnostics
• ✅ Stack ID validation from provider configuration
• ✅ Example configurations

Running Tests

# Run Asserts-specific tests
go test -v ./internal/resources/asserts/... -timeout=30m

# Run all tests including examples
TF_ACC_ASSERTS=true go test -v ./internal/resources/examples_test.go -timeout=30m

🔧 Implementation Notes

Client Configuration

• Base: Grafana instance URL
• Plugin gateway: /api/plugins/grafana-asserts-app/resources/asserts/api-server
• Services used:
  • CustomModelRulesControllerAPI: PUT model rules
  • LogConfigControllerAPI: GET tenant env config, POST upsert env config, DELETE env config by name
• DTOs:
  • Custom model rules YAML preserved round-trip to minimize diffs
  • Log drilldown uses EnvironmentDto with nested LogConfigDto

Plugin Integration

• Leverages the Asserts App Plugin for API access
• No direct backend integration
• Plugin handles routing and authentication

Resource Configuration

• Stack ID from Provider via X-Scope-OrgID
• Name-based IDs:
  • Custom model rules: name
  • Log drilldown config: environment name
• Import:
  • Log drilldown config: terraform import grafana_asserts_log_drilldown_config.name "<environment_name>"

Error Handling

• Consistent diagnostics for client configuration
• Retry on eventual consistency for reads
• Graceful handling of non-200 responses

📚 Dependencies

• github.com/grafana/grafana-asserts-public-clients/go/gcom — Generated API client (repo)
• Grafana Asserts App Plugin installed and enabled
• Grafana Service Account with appropriate permissions

🔐 Security & Permissions

• Uses Grafana Service Account authentication

• Stack-scoped access via X-Scope-OrgID

• No additional Asserts-specific tokens required

• Inherits Grafana’s security model

• Added grafana_asserts_log_drilldown_config resource with env-scoped CRUD via LogConfigControllerAPI

• Updated client to latest; adopted updated DTOs (EnvironmentDto, LogConfigDto, TenantEnvConfigResponseDto)

• Preserved existing grafana_asserts_custom_model_rules; examples, docs, tests for both resources

• Added example import script; updated docs and catalog entries

[github-actions]

In order to lower resource usage and have a faster runtime, PRs will not run Cloud tests automatically.
To do so, a Grafana Labs employee must trigger the cloud acceptance tests workflow manually.