kosli snapshot server

Report a snapshot of artifacts running in a server environment to Kosli.

This command is deprecated. Deprecated commands will be removed in a future release.

use ‘kosli snapshot paths’ instead

Synopsis

kosli snapshot server ENVIRONMENT-NAME [flags]

Report a snapshot of artifacts running in a server environment to Kosli.
You can report directory or file artifacts in one or more server paths.

When fingerprinting a ‘dir’ artifact, you can exclude certain paths from fingerprint calculation using the --exclude flag. Excluded paths are relative to the DIR-PATH and can be literal paths or glob patterns. With a directory structure like this foo/bar/zam/file.txt if you are calculating the fingerprint of foo/bar you need to exclude zam/file.txt which is relative to the DIR-PATH. The supported glob pattern syntax is what is documented here: https://pkg.go.dev/path/filepath#Match , plus the ability to use recursive globs ”**”

If the directory structure contains a symbolic link to a file (for example, a link ‘from/this/file’ and a target of ‘to/another/file’) then:

• the name of the link (‘from/this/file’) is included in the fingerprint.
• the name of the link (‘from/this/file’) is subject to .kosli_ignore entries.
• the name of the target (‘to/another/file’) is not included in the fingerprint.
• the content of target is included in the fingerprint, even if the target is outside the root directory being fingerprinted.

If the directory structure contains a symbolic link to a directory (for example, a link ‘from/this/dir’ and a target of ‘to/another/dir’) then:

• the name of the link (‘from/this/dir’) is included in the fingerprint.
• the name of the link (‘from/this/dir’) is subject to .kosli_ignore entries.
• the name of the target (‘to/another/dir’) is included in the fingerprint, even if the target is outside the root directory being fingerprinted.
• the name of the target (‘to/another/dir’) is not subject to .kosli_ignore entries.
• the content of the target is not included in the fingerprint.

To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a .kosli_ignore file to the root of the artifact. Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using #. The .kosli_ignore file is always treated as part of the artifact: its own entries cannot exclude it, so the exclusion list cannot be changed without changing the fingerprint. Paths the list already matches stay excluded whatever is later added there, so keep its entries as narrow as possible. Excluding the file with --exclude keeps it out of the fingerprint but still applies the paths it lists, which lets a writable directory change the list again. To drop the file from the fingerprint safely, move its entries to --exclude and delete it.

Flags

Flag	Type	Description
-D, --dry-run	bool	[optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors.
-e, --e	strings	[optional] The comma separated list of directories and files to exclude from fingerprinting. Can take glob patterns. (DEPRECATED: use -x instead)
-x, --exclude	strings	[optional] The comma separated list of directories and files to exclude from fingerprinting. Can take glob patterns.
-h, --help	bool	help for server
-p, --paths	strings	The comma separated list of absolute or relative paths of artifact directories or files. Can take glob patterns, but be aware that each matching path will be reported as an artifact.

Flags inherited from parent commands

Flag	Type	Description
-a, --api-token	string	The Kosli API token.
-A, --auto-environment	bool	[optional] Create the environment (with the type inferred from the snapshot subcommand) if it does not already exist, before reporting the snapshot.
-c, --config-file	string	[optional] The Kosli config file path. Config is read from this path or the default only, never implicitly from the current directory. (default “$HOME/.kosli.yml”)
--debug	bool	[optional] Print debug logs to stdout.
--environment-description	string	[optional] The environment description.
--exclude-scaling	bool	[optional] Exclude scaling events for snapshots. Snapshots with scaling changes will not result in new environment records. (DEPRECATED: this flag is deprecated and will be removed in a future version. Scaling events do not trigger new snapshots.)
-H, --host	string	[defaulted] The Kosli endpoint. (default “https://app.kosli.com”)
--http-proxy	string	[optional] The HTTP proxy URL including protocol and port number. e.g. http://proxy-server-ip:proxy-port
--include-scaling	bool	[optional] Include scaling events for snapshots. Snapshots with scaling changes will result in new environment records. (DEPRECATED: this flag is deprecated and will be removed in a future version. Scaling events do not trigger new snapshots.)
-r, --max-api-retries	int	[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)
--org	string	The Kosli organization.
-q, --quiet	bool	[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both --quiet and --debug are set, --debug wins.

Examples Use Cases

These examples all assume that the flags --api-token, --org, --host, (and --flow, --trail when required), are set/provided.

# report directory artifacts running in a server at a list of paths:
kosli snapshot server yourEnvironmentName \
	--paths a/b/c,e/f/g \
	--api-token yourAPIToken \
	--org yourOrgName  
	
# exclude certain paths when reporting directory artifacts: 
# in the example below, any path matching [a/b/c/logs, a/b/c/*/logs, a/b/c/*/*/logs]
# will be skipped when calculating the fingerprint
kosli snapshot server yourEnvironmentName \
	--paths a/b/c \
	--exclude logs,"*/logs","*/*/logs"
	--api-token yourAPIToken \
	--org yourOrgName 
	
# use glob pattern to match paths to report them as directory artifacts: 
# in the example below, any path matching "*/*/src" under top-dir/ will be reported as a separate artifact.
kosli snapshot server yourEnvironmentName \
	--paths "top-dir/*/*/src" \
	--api-token yourAPIToken \
	--org yourOrgName