5.11. メトリックの作成
3scale toolbox を使用して、デベロッパーポータルのメトリックの作成、更新、リスト表示、および削除を行います。
メトリックを作成するには、以下の手順に従います。
- メトリック名を指定する必要があります。
-
system-name
を上書きするには、オプションのパラメーターを使用します。 - 同じ名前のメトリックがすでに存在する場合、エラーメッセージが表示されます。
--disabled
フラグを使用して、無効な
メトリックを作成します。-
デフォルトでは、
有効
になります。
-
デフォルトでは、
service
位置引数はサービスの参照で、サービスのid
またはサービスのsystem_name
のどちらかです。- toolbox は、どちらか一方を使用します。
以下のコマンドにより、メトリックが作成されます。
3scale metric create [opts] <remote> <service> <metric-name>
メトリックの作成時に、以下のオプションを使用します。
Options --description=<value> Set a metric description --disabled Disable this metric in all application plans -o --output=<value> Output format on stdout: one of json|yaml -t --system-name=<value> Set the application plan system name --unit=<value> Metric unit: default hit Options for metric -c --config-file=<value> 3scale toolbox configuration file: defaults to $HOME/.3scalerc.yaml -h --help Print help for this command -k --insecure Proceed and operate even for server connections otherwise considered insecure -v --version Print the version of this command --verbose Verbose mode
5.11.1. メトリックの作成または更新
メトリックが存在しない場合に新しく作成する、または既存のメトリックを更新するには、以下の手順に従います。
- 同じ名前のメトリックがすでに存在する場合、エラーメッセージが表示されます。
-
--disabled
フラグを使用して、無効な
メトリックを更新します。 -
--enabled
フラグを使用して、有効な
メトリックに更新します。
service
位置引数はサービスの参照で、サービスのid
またはサービスのsystem_name
のどちらかです。- toolbox は、どちらか一方を使用します。
metric
位置引数はメトリック参照で、メトリックのid
またはメトリックのsystem_name
のどちらかです。- toolbox は、どちらか一方を使用します。
以下のコマンドにより、メトリックが更新されます。
3scale metric apply [opts] <remote> <service> <metric>
メトリックの更新時に、以下のオプションを使用します。
Options --description=<value> Set a metric description --disabled Disable this metric in all application plans --enabled Enable this metric in all application plans -n --name=<value> This will set the metric name --unit=<value> Metric unit: default hit -o --output=<value> Output format on stdout: one of json|yaml Options for metric -c --config-file=<value> 3scale toolbox configuration file: defaults to $HOME/.3scalerc.yaml -h --help Print help for this command -k --insecure Proceed and operate even for server connections otherwise considered insecure -v --version Print the version of this command --verbose Verbose mode
5.11.2. メトリックのリスト表示
以下のコマンドにより、メトリックがリスト表示されます。
3scale metric list [opts] <remote> <service>
メトリックのリスト表示時に、以下のオプションを使用します。
Options -o --output=<value> Output format on stdout: one of json|yaml Options for metric -c --config-file=<value> 3scale toolbox configuration file: defaults to $HOME/.3scalerc.yaml -h --help Print help for this command -k --insecure Proceed and operate even for server connections otherwise considered insecure -v --version Print the version of this command --verbose Verbose mode
5.11.3. メトリックの削除
以下のコマンドにより、メトリックが削除されます。
3scale metric delete [opts] <remote> <service> <metric>
メトリックの削除時に、以下のオプションを使用します。
Options for metric -c --config-file=<value> 3scale toolbox configuration file: defaults to $HOME/.3scalerc.yaml -h --help Print help for this command -k --insecure Proceed and operate even for server connections otherwise considered insecure -v --version Print the version of this command --verbose Verbose mode