Commit ff5e52de authored by Matthias Käppler's avatar Matthias Käppler 3️⃣
Browse files

Merge branch 'refactor-user-experience-sli' into 'master' 

feat: Renaming Covered Experience to User Experience SLI

See merge request !201

Merged-by: Matthias Käppler's avatarMatthias Käppler <mkaeppler@gitlab.com>
Approved-by: Elliot Forbes's avatarElliot Forbes <eforbes@gitlab.com>
Approved-by: Matthias Käppler's avatarMatthias Käppler <mkaeppler@gitlab.com>
Reviewed-by: Matthias Käppler's avatarMatthias Käppler <mkaeppler@gitlab.com>
Co-authored-by: Hercules Merscher's avatarHercules Merscher <hmerscher@gitlab.com>
parents eef0fa55 48e956d7

README.md

+1 −1
Original line number Diff line number Diff line
@@ -20,7 +20,7 @@ LabKit-Ruby provides functionality in a number of areas: 


1. `Labkit::Context` used for providing context information to log messages.

1. `Labkit::Correlation` for accessing the correlation id. (Generated and propagated by `Labkit::Context`)

1. `Labkit::CoveredExperience` for tracking covered experiences. More on the [README](./lib/labkit/covered_experience/README.md).

1. `Labkit::UserExperienceSli` for tracking User Experience SLIs. More on the [README](./lib/labkit/user_experience_sli/README.md).

1. `Labkit::FIPS` for checking for FIPS mode and using FIPS-compliant algorithms.

1. `Labkit::Logging` for sanitizing log messages.

1. `Labkit::Metrics` for metrics. More on the [README](./lib/labkit/metrics/README.md).

config/covered_experiences/schema.json→config/user_experience_slis/schema.json

+5 −5
Original line number Diff line number Diff line 
{

  "$schema": "http://json-schema.org/draft-06/schema#",

  "$id": "https://gitlab.com/gitlab-org/ruby/gems/labkit-ruby/-/raw/master/config/covered_experiences/schema.json",

  "title": "Covered Experience Definition",

  "description": "Schema for GitLab Covered Experience files",

  "$id": "https://gitlab.com/gitlab-org/ruby/gems/labkit-ruby/-/raw/master/config/user_experience_slis/schema.json",

  "title": "User Experience SLI Definition",

  "description": "Schema for GitLab User Experience SLI files",

  "type": "object",

  "properties": {

    "description": {

      "type": "string",

      "minLength": 1,

      "description": "Human-readable description of the covered experience"

      "description": "Human-readable description of the user experience"

    },

    "feature_category": {

      "type": "string",
@@ -23,7 +23,7 @@ 
        "async_fast",

        "async_slow"

      ],

      "description": "Urgency level for this covered experience"

      "description": "Urgency level for this user experience"

    }

  },

  "required": [

lib/gitlab-labkit.rb

+2 −1
Original line number Diff line number Diff line
@@ -9,7 +9,8 @@ module Labkit 


  autoload :Context, "labkit/context"

  autoload :Correlation, "labkit/correlation"

  autoload :CoveredExperience, "labkit/covered_experience"

  autoload :CoveredExperience, "labkit/user_experience_sli" # Backward compatibility alias

  autoload :UserExperienceSli, "labkit/user_experience_sli"

  autoload :FIPS, "labkit/fips"

  autoload :Tracing, "labkit/tracing"

  autoload :Logging, "labkit/logging"

lib/labkit/covered_experience/error.rb

deleted100644 → 0
+0 −9
Original line number Diff line number Diff line 
# frozen_string_literal: true



module Labkit

  module CoveredExperience

    CoveredExperienceError = Class.new(StandardError)

    NotFoundError = Class.new(CoveredExperienceError)

    ReservedKeywordError = Class.new(CoveredExperienceError)

  end

end