fsoc
fsoc - Cisco Observability Platform Control Tool
Synopsis
fsoc is an open source utility that serves as a command line interface to the Cisco Observability Platform (https://developer.cisco.com/docs/cisco-observability-platform).
fsoc provides a set of commands to interact with the platform. It allows developers to interact in a uniform way with the platform's different environments (development, test, production) and conveniently switch between them. fsoc primarily targets developers building solutions on the platform.
You can use the --config and --profile flags to select authentication credentials to use. You can also use environment variables FSOC_CONFIG and FSOC_PROFILE, respectively. The command line flags take precedence. If a profile is not specified otherwise, the current profile from the config file is used.
fsoc checks once a day if a newer version is available on github and warns if not running the latest stable version. You can use the --no-version-check flag or the FSOC_NO_VERSION_CHECK=1 environment variable to suppress the check.
fsoc logs its execution details into a log file. By default, fsoc shows only warning- and error-level log messages on the output. You can use the --verbose flag to show all log messages and/or the --log flag to set a desired location for saving the log file.
Detailed user docs for fsoc are available at https://developer.cisco.com/docs/cisco-observability-platform/#!overview. For source code and build instructions, see also https://github.com/cisco-open/fsoc.
NOTE: fsoc is in alpha; breaking changes may occur.
Examples
fsoc config create auth=oauth url=https://MYTENANT.observe.appdynamics.com
fsoc uql "FETCH id, type, attributes FROM entities(k8s:workload)"
fsoc solution list
fsoc solution list -o json
FSOC_CONFIG=tenant5-config.yaml fsoc solution subscribe spacefleet --profile admin
Options
--config string config file (default is ~/.fsoc). May be .yaml or .json
--curl log curl equivalent for platform API calls (implies --verbose)
--fields string perform specified fields transform/extract JQ expression
-h, --help help for fsoc
--log string set a location and name for the fsoc log file (default "/tmp/fsoc.log")
--no-version-check skip the daily check for new versions of fsoc
-o, --output string output format (auto, table, detail, json, yaml) (default "auto")
--profile string access profile (default is current or "default")
-v, --verbose enable detailed output
See Also
- fsoc completion - Generate the autocompletion script for the specified shell
- fsoc config - Configure fsoc
- fsoc gendocs - Generate docs for fsoc
- fsoc iam-role - Manage IAM roles
- fsoc iam-role-binding - Manage IAM role bindings
- fsoc knowledge - Perform Knowledge Store operations
- fsoc login - Login to profile, obtain and save JWT token for future commands
- fsoc logs - Display solution logs
- fsoc melt - Generates fsoc telemetry data models and sends OTLP payloads to the platform ingestion services
- fsoc optimize - Perform optimize interactions
- fsoc proxy - Proxy local http requests to platform
- fsoc solution - Perform solution operations
- fsoc uql - Perform UQL query
- fsoc version - Print fsoc version