update the configuration flags + readme

README.md

@@ -63,10 +63,11 @@ COMMANDS:
 GLOBAL OPTIONS:
  --help, -h show help
 
- Kinesis Configuration:
+ DataStream Configuration:
 
- --kinesis.region value The region of the AWS Kinesis Data Stream [$HERMES_KINESIS_REGION]
- --kinesis.stream value The name of the AWS Kinesis Data Stream [$HERMES_KINESIS_DATA_STREAM]
+ --data.stream.type value Format where the traces will be submitted: logger, kinesis, or callback. (default: "logger") [$HERMES_DATA_STREAM_TYPE]
+ --kinesis.region value The region of the AWS Kinesis Data Stream [$HERMES_KINESIS_REGION]
+ --kinesis.stream value The name of the AWS Kinesis Data Stream [$HERMES_KINESIS_DATA_STREAM]
 
  Logging Configuration:
 

cmd/hermes/cmd.go

@@ -23,9 +23,9 @@ import (
 )
 
 const (
- flagCategoryLogging = "Logging Configuration:"
- flagCategoryTelemetry = "Telemetry Configuration:"
- flagCategoryKinesis = "Kinesis Configuration:"
+ flagCategoryLogging  = "Logging Configuration:"
+ flagCategoryTelemetry  = "Telemetry Configuration:"
+ flagCategoryDataStream = "DataStream Configuration:"
 )
 
 var rootConfig = struct {
@@ -175,26 +175,26 @@ var rootFlags = []cli.Flag{
  &cli.StringFlag{
  Name: "data.stream.type",
  EnvVars: []string{"HERMES_DATA_STREAM_TYPE"},
- Usage: "Format where the traces will be submitted.",
+ Usage: "Format where the traces will be submitted: logger, kinesis, or callback.",
  Value: rootConfig.DataStreamType,
  Destination: &rootConfig.DataStreamType,
- Category: flagCategoryTelemetry,
+ Category: flagCategoryDataStream,
  },
  &cli.StringFlag{
  Name: "kinesis.region",
  EnvVars: []string{"HERMES_KINESIS_REGION"},
  Usage: "The region of the AWS Kinesis Data Stream",
  Value: rootConfig.KinesisRegion,
  Destination: &rootConfig.KinesisRegion,
- Category: flagCategoryKinesis,
+ Category: flagCategoryDataStream,
  },
  &cli.StringFlag{
  Name: "kinesis.stream",
  EnvVars: []string{"HERMES_KINESIS_DATA_STREAM"},
  Usage: "The name of the AWS Kinesis Data Stream",
  Value: rootConfig.KinesisStream,
  Destination: &rootConfig.KinesisStream,
- Category: flagCategoryKinesis,
+ Category: flagCategoryDataStream,
  },
 }