c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🦋 c8y(1) 🦋

okay so welcome to the c8y(1) manual page bestie 💖 this is the one about pulling up your activity log — like, every request that went down — and then filtering it down to exactly the tea you wanna see. no cap, it's lowkey one of the most useful things in here.

🌸 NAME 🌸

c8y-activitylog-list — Get activity log entries 👑

✨ SYNOPSIS ✨

c8y activitylog list [flags]

💅 DESCRIPTION 💅

View activity log entries and filter for specific information. that's it, that's the vibe — you look at the entries, you narrow them down to the stuff you actually care about, you move on with your life 🫶

🎀 OPTIONS 🎀

these are the options that belong to list itself, main character energy only:

  • --dateFrom="" — Start date or date and time of the log entry 🌅
  • --dateTo="" — End date or date and time of the log entry 🌇
  • -h, --help[=false] — help for list (we love a helper)
  • --type="request" — Type of entry, defaults to "request" ⭐

🧚 OPTIONS INHERITED FROM PARENT COMMANDS 🧚

these come down from the parent commands, so they're just... there, being iconic. all of them. yes, all of them 💀

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin)
  • --cache[=false] — Enable cached responses
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m
  • -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal
  • --confirm[=false] — Prompt for confirmation
  • --confirmText="" — Custom confirmation text
  • --currentPage=0 — Current page which should be returned
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'
  • --debug[=false] — Set very verbose log messages 🐛
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s
  • --dry[=false] — Dry run. Don't send any data to the server 🙈
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl
  • --examples[=false] — Show examples for the current command
  • --filter=[] — Apply a client side filter to response before returning it to the user
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — Include all results by iterating through each page
  • -k, --insecure[=false] — Allow insecure server connections when using SSL
  • -l, --logMessage="" — Add custom message to the activity log
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution! ⚠️)
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting)
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console
  • --noLog[=false] — Disables the activity log for the current command
  • --noProgress[=false] — Disable progress bars
  • --noProxy[=false] — Ignore the proxy settings
  • -n, --nullInput[=false] — Don't read the input (stdin). Useful if using in shell for/while loops
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader
  • --outputFile="" — Save JSON output to file (after select/view)
  • --outputFileRaw="" — Save raw response to file (before select/view)
  • --outputTemplate="" — jsonnet template to apply to the output
  • -p, --pageSize=5 — Maximum results per page
  • --progress[=false] — Show progress bar. This will also disable any other verbose output
  • --proxy="" — Proxy setting, i.e. http://10.0.0.1:8080
  • -r, --raw[=false] — Show raw response. This mode will force output=json and view=off
  • --retries=3 — Max number of attempts when a failed http call is encountered
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'
  • --session="" — Session configuration
  • --sessionMode="" — Override default session mode for a single command which would normally be disabled
  • -P, --sessionPassword="" — Override session password 🤫
  • -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant)
  • --silentExit[=false] — Silent status codes do not affect the exit code
  • --silentStatusCodes="" — Status codes which will not print out an error message
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m ⏳
  • --totalPages=0 — Total number of pages to get
  • -v, --verbose[=false] — Verbose logging
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off
  • --withError[=false] — Errors will be printed on stdout instead of stderr
  • --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13)
  • -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages
  • --workers=1 — Number of workers

🔥 EXAMPLE 🔥

okay these are the moments, bestie. copy these, they ate:

$ c8y activitylog list --dateFrom -1h

Show entries from the last hour ⏰

$ c8y activitylog list --dateFrom -8h --filter "method match PUT|POST"

Show entries from the last 8 hours only included PUT and POST requests

$ c8y activitylog list --filter "statusCode > 299"

Show all failed requests 💀

$ c8y activitylog list --filter "method eq POST" --select responseTimeMS,time,ctx,responseSelf -o csv | sort -n | tail -5

Get the top 5 slowest response times from POST requests. literal detective work 🔍

🌈 SEE ALSO 🌈

and that's the page!! 💜 this one's from Jan 1980 and it's the c8y(1) manual — iconic since day one, no cap ✨🎀

📦 where this page comes from