Versions Compared

Old Version 1

changes.mady.by.user Patrice Neff

Saved on

compared with

New Version 2

changes.mady.by.user Patrice Neff

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

Excerpt

The squirro_widget comand line tool, part of the Toolbox, is used to manage custom widgets on a Squirro cluster.

...


Table of Contents

Table of Contents
outlinetrue
excludeExecutive Summary|Table of Contents

...

Code Block
languagepowershell
squirro_widget ^
    --token SQUIRRO_TOKEN ^
    --cluster https://next.squirro.net  ^
    list

Note that the lines have been wrapped with the circumflex (^) at the end of each line. On Mac and Linux you will need to use backslash (\) instead.

Arguments

The following table lists all the arguments.

ArgumentMandatoryDescription
General Options
-h 
Show a help message and exit.
--version 
Output the tool version and exit.
--verbose, -v 

Increase log verbosity.

  • Not specified: the tool outputs all warnings and errors.
  • Specified once or more: informational messages are also output.
  • Specified twice or more: debugging messages are shown.
      • Specified three times or more: more information is included in all messages.
--log-file 
Path to a log file on disk, where the log output is to be stored. If this is not specified, the log messages are shown on the console.
Connection Options (see Connecting to Squirro for finding these values)
--token TOKEN
-t TOKEN		YesThe Authentication Token with which to authenticate.
If the token value starts with a dash, you need to use an equal sign to specify the value like this: --token="-12345…"

--cluster URL
-c URL

 


The Squirro cluster into which to import the data.

...

Code Block
languagepowershell
squirro_widget ^
    --token SQUIRRO_TOKEN ^
    --cluster https://next.squirro.net  ^
    list

Note that the lines have been wrapped with the circumflex (^) at the end of each line. On Mac and Linux you will need to use backslash (\) instead.

Upload

The upload command uploads a custom widget from the local disk and uploads it to the Squirro cluster. This command takes additional options beyond the default arguments.

ArgumentMandatoryDescription
--configYes

A JSON representation of the configuration for the widget. The following keys are possible:

KeyDescription
directoryThe local directory in which the widget is stored - relative to the current working directory. The directory is also used to determine the widget name. That name is used for deduplication, any older widgets with the same name are overwritten.
titleThe name of the widget. This is the name shown to users when they add the widget to a dashboard.
baseWidget

The name of the base widget from which this one inherits. This drives the configuration options that are displayed to the user when adding the widget to a dashboard.

See the list of Base Widgets for possible values here.

An example:

Code Block
languagepowershell
squirro_widget ^
    --cluster https://next.squirro.net ^
    --token $TOKEN ^
    upload ^
    --config '{"directory": "clock", "title": "Clock", "baseWidget": "Base"}'

...