c8y(1)

πŸ“¦ version 2.56.1, in nixpkgs unstable

✨ c8y(1) β€” the microservices loglevels get glow-up ✨

okay bestie, so this is the c8y manual page, and today's main character is c8y-microservices-loglevels-get β€” the little command that gets the log level of a microservice. yes. we're doing this. πŸ’…


πŸŽ€ NAME πŸŽ€

c8y-microservices-loglevels-get β€” get log level of microservice. literally that's the whole gig, and she does it well. ✨


🌸 SYNOPSIS 🌸

c8y microservices loglevels get [flags]

that's it. that's the shape of it. flags go on the end, obviously. 🫢


πŸ’– DESCRIPTION πŸ’–

so listen β€” you use this to get the configured log level for a package (incl. sub-packages), or for one specific class. highkey useful, lowkey niche.

heads up bestie: this only works for Spring Boot microservices based on Cumulocity Java Microservice SDK. if yours isn't one of those, she cannot help you, and that's not a vibe thing, that's just how it is 😭

🌈 OPTIONS 🌈

  • -h, --help[=false] β€” help for get. your emergency "what do i do" button 🧚
  • --loggerName="" β€” name of the logger: the qualified name of a package or class. required πŸ‘‘
  • --name="" β€” the microservice name. also required, bestie, don't forget her πŸ’œ

🌟 OPTIONS INHERITED FROM PARENT COMMANDS 🌟

these are the ones handed down from the parent commands, like family recipes but for flags. πŸ“

  • --abortOnErrors=10 β€” abort the batch when it reaches the specified number of errors. ten is the mood, but it's configurable.
  • --allowEmptyPipe[=false] β€” don't fail when the piped input (stdin) is empty. be forgiving, queen. 🫢
  • --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. slay πŸ’…
  • --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. unhinged amounts of detail, we love her.
  • --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. pretend mode ✨
  • --dryFormat="markdown" β€” dry run output format, i.e. json, dump, markdown or curl.
  • --examples[=false] β€” show examples for the current command. yes please, show me the lore.
  • --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. no crumbs left behind πŸŽ€
  • -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!). bestie that caution is doing a LOT of work here πŸ’€
  • --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. (sad, but valid)
  • --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. very for-loop-coded of her.
  • -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. she said no filter and she meant it.
  • --retries=3 β€” max number of attempts when a failed http call is encountered. three strikes but make it resilient πŸ’ͺ
  • --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 πŸ”₯

bestie, examples are the whole point. look at these. look at them. πŸ‘‘

$ c8y microservices loglevels get --name my-microservice --loggerName org.example
Get log level of microservice for a package
$ c8y microservices loglevels get --name my-microservice --loggerName org.example.microservice.ClassName
Get log level of microservice for a specific class

see how the second one goes all the way down to org.example.microservice.ClassName? that's the specific-class glow-up. iykyk πŸ¦‹


πŸ’œ SEE ALSO πŸ’œ


quick vibe check recap πŸ’…: --name and --loggerName are both required, this only works on Spring Boot microservices based on Cumulocity Java Microservice SDK, and --maxJobs=0 means unlimited, so use with caution. periodt.

and that's the page! sign-off time: this little beauty comes from the c8y source/version and the date on the original footer is Jan 1980 β€” which is iconic and also apparently when the vibe was born πŸŽ€πŸ¦‹ no cap, she's timeless. mwah. πŸ’–

πŸ“¦ where this page comes from