Module: GitlabInternalEventsCli

Defined in:: lib/gitlab_internal_events_cli/global_state.rb,
lib/gitlab_internal_events_cli.rb,
lib/gitlab_internal_events_cli/cli.rb,
lib/gitlab_internal_events_cli/event.rb,
lib/gitlab_internal_events_cli/metric.rb,
lib/gitlab_internal_events_cli/helpers.rb,
lib/gitlab_internal_events_cli/version.rb,
lib/gitlab_internal_events_cli/http_cache.rb,
lib/gitlab_internal_events_cli/configuration.rb,
lib/gitlab_internal_events_cli/gitlab_prompt.rb,
lib/gitlab_internal_events_cli/helpers/files.rb,
lib/gitlab_internal_events_cli/schema_resolver.rb,
lib/gitlab_internal_events_cli/version_checker.rb,
lib/gitlab_internal_events_cli/text/flow_advisor.rb,
lib/gitlab_internal_events_cli/flows/flow_advisor.rb,
lib/gitlab_internal_events_cli/flows/usage_viewer.rb,
lib/gitlab_internal_events_cli/helpers/cli_inputs.rb,
lib/gitlab_internal_events_cli/helpers/formatting.rb,
lib/gitlab_internal_events_cli/text/event_definer.rb,
lib/gitlab_internal_events_cli/flows/event_definer.rb,
lib/gitlab_internal_events_cli/text/metric_definer.rb,
lib/gitlab_internal_events_cli/flows/metric_definer.rb,
lib/gitlab_internal_events_cli/time_framed_key_path.rb,
lib/gitlab_internal_events_cli/helpers/event_options.rb,
lib/gitlab_internal_events_cli/helpers/schema_loader.rb,
lib/gitlab_internal_events_cli/helpers/metric_options.rb,
lib/gitlab_internal_events_cli/helpers/group_ownership.rb,
lib/gitlab_internal_events_cli/subflows/event_metric_definer.rb,
lib/gitlab_internal_events_cli/helpers/service_ping_dashboards.rb,
lib/gitlab_internal_events_cli/subflows/database_metric_definer.rb

Overview

Helpers for generating service ping exploration dashboards links

Defined Under Namespace

Modules: Flows, Helpers, Subflows, Text Classes: Cli, Configuration, Error, Event, ExistingEvent, ExistingMetric, GitlabPrompt, GlobalState, HttpCache, Metric, NewEvent, NewMetric, SchemaResolver, TimeFramedKeyPath, VersionChecker

Constant Summary collapse

NEW_EVENT_FIELDS =

%i[
  description
  internal_events
  status
  category
  action
  value_type
  extra_properties
  identifiers
  additional_properties
  product_group
  product_categories
  milestone
  introduced_by_url
  tiers
  classification
].freeze

EVENT_DEFAULTS =

{
  internal_events: true,
  status: 'active',
  product_group: nil,
  introduced_by_url: 'TODO'
}.freeze

NEW_METRIC_FIELDS =

%i[
  key_path
  description
  product_group
  product_categories
  performance_indicator_type
  value_type
  status
  milestone
  introduced_by_url
  time_frame
  data_source
  data_category
  tiers
  events
  instrumentation_class
].freeze

ADDITIONAL_METRIC_FIELDS =

%i[
  milestone_removed
  removed_by_url
  removed_by
  repair_issue_url
  value_json_schema
  name
].freeze

METRIC_DEFAULTS =

{
  product_group: nil,
  introduced_by_url: 'TODO',
  value_type: 'number',
  status: 'active',
  data_source: 'internal_events',
  data_category: 'optional',
  performance_indicator_type: []
}.freeze

VERSION =

'0.1.1'

Class Attribute Summary collapse

.configuration ⇒ Object

Class Method Summary collapse

.configure {|configuration| ... } ⇒ Object
.reset_configuration! ⇒ Object

Class Attribute Details

.configuration ⇒ `Object`



113
114
115

# File 'lib/gitlab_internal_events_cli/configuration.rb', line 113

def configuration
  @configuration ||= Configuration.new
end

Class Method Details

.configure {|configuration| ... } ⇒ `Object`

Yields:

(configuration)



117
118
119

# File 'lib/gitlab_internal_events_cli/configuration.rb', line 117

def configure
  yield(configuration)
end

.reset_configuration! ⇒ `Object`



121
122
123

# File 'lib/gitlab_internal_events_cli/configuration.rb', line 121

def reset_configuration!
  @configuration = Configuration.new
end