health.json

{
  "name": "tcurl",
  "description": [
    "tcurl --health <service>",
    "Send a TChannel/Thrift Meta::health check to a service."
  ],
  "usage": [
    "--health",
    "[-s|--service] <service>\n    The name of the TChannel/Hyperbahn service to check",
    "[-p|--peer <peer>...]\n    The peer or peers to connect",
    "[-P|--peerlist|-H|--hostlist <path>]\n    The path to a file containing a JSON list of peers",
    "[--timeout <ms>] :quantity\n    Timeout in milliseconds",
    "[--cn|--caller <cn>]\n    Fake an alternate caller service name, tcurl by default",
    "[--sk|--shard-key|--shardKey <sk>]\n    Ringpop shard key\n    Favor --sk and --shard-key. --shardKey is deprecated.",
    "[--rd|--routing-delegate <rd>]\n    Route through the delegated service",
    "[--requests <count>] :quantity\n    Number of requests to make",
    "[--rate <rate>] :quantity\n    Request rate in requests per second",
    "[--delay <ms>] :quantity\n    Delay between requests in milliseconds",
    "[--time <ms>] :quantity\n    Benchmark duration in milliseconds"
  ],
  "terms": {
    "health": {
      "flags": [
        {
          "flag": "--health",
          "long": true
        }
      ],
      "arg": null,
      "command": null,
      "collectorType": null,
      "type": null,
      "required": true,
      "minLength": null,
      "maxLength": null,
      "help": ""
    },
    "service": {
      "flags": [
        {
          "flag": "-s",
          "short": true
        },
        {
          "flag": "--service",
          "long": true
        }
      ],
      "arg": "service",
      "command": null,
      "collectorType": null,
      "type": null,
      "required": true,
      "minLength": null,
      "maxLength": null,
      "help": "The name of the TChannel/Hyperbahn service to check",
      "optionalFlag": true
    },
    "peers": {
      "flags": [
        {
          "flag": "-p",
          "short": true
        },
        {
          "flag": "--peer",
          "long": true
        }
      ],
      "arg": "peer",
      "command": null,
      "collectorType": "array",
      "type": null,
      "required": false,
      "minLength": 0,
      "maxLength": null,
      "help": "The peer or peers to connect"
    },
    "hostlist": {
      "flags": [
        {
          "flag": "-P",
          "short": true
        },
        {
          "flag": "--peerlist",
          "long": true
        },
        {
          "flag": "-H",
          "short": true
        },
        {
          "flag": "--hostlist",
          "long": true
        }
      ],
      "arg": "path",
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "The path to a file containing a JSON list of peers"
    },
    "timeout": {
      "flags": [
        {
          "flag": "--timeout",
          "long": true
        }
      ],
      "arg": "ms",
      "command": null,
      "collectorType": null,
      "type": "quantity",
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Timeout in milliseconds"
    },
    "callerName": {
      "flags": [
        {
          "flag": "--cn",
          "long": true
        },
        {
          "flag": "--caller",
          "long": true
        }
      ],
      "arg": "cn",
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Fake an alternate caller service name, tcurl by default"
    },
    "shardKey": {
      "flags": [
        {
          "flag": "--sk",
          "long": true
        },
        {
          "flag": "--shard-key",
          "long": true
        },
        {
          "flag": "--shardKey",
          "long": true
        }
      ],
      "arg": "sk",
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Ringpop shard key\n    Favor --sk and --shard-key. --shardKey is deprecated."
    },
    "routingDelegate": {
      "flags": [
        {
          "flag": "--rd",
          "long": true
        },
        {
          "flag": "--routing-delegate",
          "long": true
        }
      ],
      "arg": "rd",
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Route through the delegated service"
    },
    "requests": {
      "flags": [
        {
          "flag": "--requests",
          "long": true
        }
      ],
      "arg": "count",
      "command": null,
      "collectorType": null,
      "type": "quantity",
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Number of requests to make"
    },
    "rate": {
      "flags": [
        {
          "flag": "--rate",
          "long": true
        }
      ],
      "arg": "rate",
      "command": null,
      "collectorType": null,
      "type": "quantity",
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Request rate in requests per second"
    },
    "delay": {
      "flags": [
        {
          "flag": "--delay",
          "long": true
        }
      ],
      "arg": "ms",
      "command": null,
      "collectorType": null,
      "type": "quantity",
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Delay between requests in milliseconds"
    },
    "time": {
      "flags": [
        {
          "flag": "--time",
          "long": true
        }
      ],
      "arg": "ms",
      "command": null,
      "collectorType": null,
      "type": "quantity",
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Benchmark duration in milliseconds"
    }
  },
  "parsers": {},
  "converters": {},
  "validators": {},
  "collectors": {}
}