services/ws/doc.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 // Arvados-ws exposes Arvados APIs (currently just one, the
   6 // cache-invalidation event feed at "ws://.../websocket") to
   7 // websocket clients.
   8 //
   9 // Installation and configuration
  10 //
  11 // See https://doc.arvados.org/install/install-ws.html.
  12 //
  13 // Developer info
  14 //
  15 // See https://dev.arvados.org/projects/arvados/wiki/Hacking_websocket_server.
  16 //
  17 // Usage
  18 //
  19 //     arvados-ws [-legacy-ws-config /etc/arvados/ws/ws.yml] [-dump-config]
  20 //
  21 // Options
  22 //
  23 // -legacy-ws-config path
  24 //
  25 // Load legacy configuration from the given file instead of the default
  26 // /etc/arvados/ws/ws.yml, legacy config overrides the clusterwide config.yml.
  27 //
  28 // -dump-config
  29 //
  30 // Print the loaded configuration to stdout and exit.
  31 //
  32 // Logs
  33 //
  34 // Logs are printed to stderr, formatted as JSON.
  35 //
  36 // A log is printed each time a client connects or disconnects.
  37 //
  38 // Enable additional logs by configuring:
  39 //
  40 //     LogLevel: debug
  41 //
  42 // Runtime status
  43 //
  44 // GET /debug.json responds with debug stats.
  45 //
  46 // GET /status.json responds with health check results and
  47 // activity/usage metrics.
  48 package main