Class: Command::Logs

Inherits:
Base
  • Object
show all
Defined in:
lib/command/logs.rb

Constant Summary collapse

NAME = 
"logs"
OPTIONS = 
[
  app_option(required: true),
  workload_option,
  replica_option,
  logs_limit_option,
  logs_since_option
].freeze
DESCRIPTION = 
"Light wrapper to display tailed raw logs for app/workload syntax"
LONG_DESCRIPTION = 
<<~DESC
  - Light wrapper to display tailed raw logs for app/workload syntax
  - Defaults to showing the last 200 entries from the past 1 hour before tailing
DESC
EXAMPLES = 
<<~EX
  ```sh
  # Displays logs for the default workload (`one_off_workload`).
  cpflow logs -a $APP_NAME

  # Displays logs for a specific workload.
  cpflow logs -a $APP_NAME -w $WORKLOAD_NAME

  # Displays logs for a specific replica of a workload.
  cpflow logs -a $APP_NAME -w $WORKLOAD_NAME -r $REPLICA_NAME

  # Uses a different limit on number of entries.
  cpflow logs -a $APP_NAME --limit 100

  # Uses a different loopback window.
  cpflow logs -a $APP_NAME --since 30min
  ```
EX

Constants inherited from Base

Base::ACCEPTS_EXTRA_OPTIONS, Base::ALL_VALIDATIONS, Base::DEFAULT_ARGS, Base::HIDE, Base::REQUIRES_ARGS, Base::USAGE, Base::VALIDATIONS, Base::VALIDATIONS_WITHOUT_ADDITIONAL_OPTIONS, Base::VALIDATIONS_WITH_ADDITIONAL_OPTIONS, Base::WITH_INFO_HEADER

Instance Attribute Summary

Attributes inherited from Base

#config

Instance Method Summary collapse

Methods inherited from Base

add_app_identity_option, all_commands, all_options, all_options_by_key_name, app_option, #args_join, commit_option, common_options, #cp, cpu_option, detached_option, docker_context_option, domain_option, #ensure_docker_running!, entrypoint_option, image_option, #initialize, interactive_option, location_option, log_method_option, logs_limit_option, logs_since_option, memory_option, org_option, #progress, replica_option, #run_command_in_latest_image, #run_cpflow_command, run_release_phase_option, skip_confirm_option, skip_post_creation_hook_option, skip_pre_deletion_hook_option, skip_secret_access_binding_option, skip_secrets_setup_option, #step, #step_finish, terminal_size_option, trace_option, upstream_token_option, use_local_token_option, validations_option, verbose_option, version_option, wait_option, #with_retry, workload_option

Methods included from Helpers

normalize_command_name, normalize_option_name, random_four_digits, strip_str_and_validate

Constructor Details

This class inherits a constructor from Command::Base

Instance Method Details

#call ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/command/logs.rb', line 37

def call
  workload = config.options[:workload] || config[:one_off_workload]
  replica = config.options[:replica]
  limit = config.options[:limit]
  since = config.options[:since]

  message = replica ? "replica '#{replica}'" : "workload '#{workload}'"
  progress.puts("Fetching logs for #{message}...\n\n")

  cp.logs(workload: workload, replica: replica, limit: limit, since: since)
end