This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
metrics-profile
The following operations can be performed on “metrics-profile”:
| add | set | unset | rm | show | bind | unbind |
add metrics profile
Adds a new metrics profile
Synopsis
add metrics profile
Arguments
name Name for the metrics profile. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.!
collector The collector should be a HTTP/HTTPS service.
outputMode This option indicates the format in which metrics data is generated
Possible values: avro, prometheus, influx, json Default value: avro,
metrics This option is used enable or disable metrics
Possible values: ENABLED, DISABLED Default value: DISABLED
serveMode This option is to configure metrics pull or push mode. In push mode metricscollector exports metrics to configured collector. In pull mode, metricscollector only generates the metrics which will be pulled by external agent. No collector configuration is required in pull mode and it is applicable only for output mode Prometheus
Possible values: Push, Pull Default value: Push
schemaFile This option is for configuring json schema file containing a list of counters to be exported by metricscollector. Schema file should be present under /var/metrics_conf path Default value: NS_S_ANALYTICS_DEFAULT_SCHEMA_FILE Maximum value: 64
metricsExportFrequency This option is for configuring the metrics export frequency in seconds, frequency value must be in [30,300] seconds range Default value: 30 Minimum value: 30 Maximum value: 300
metricsAuthToken
Token for authenticating with the endpoint. If the endpoint requires the Authorization header in a particular format, specify the complete format as the value to this parameter. For eg., in case of splunk, the Authorizaiton header is required to be of the form - Splunk
metricsEndpointUrl The URL at which to upload the metrics data on the endpoint Maximum value: 256
Example
add metrics profile metrics_profile1
set metrics profile
Sets an metrics profile!
Synopsis
set metrics profile
Arguments
name Name for the metrics profile. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.!
collector The collector should be a HTTP/HTTPS service.
outputMode This option indicates the format in which metrics data is generated
Possible values: avro, prometheus, influx, json Default value: avro,
metrics This option is used enable or disable metrics
Possible values: ENABLED, DISABLED Default value: DISABLED
serveMode This option is to configure metrics pull or push mode. In push mode metricscollector exports metrics to configured collector. In pull mode, metricscollector only generates the metrics which will be pulled by external agent. No collector configuration is required in pull mode and it is applicable only for output mode Prometheus
Possible values: Push, Pull Default value: Push
schemaFile This option is for configuring json schema file containing a list of counters to be exported by metricscollector. Schema file should be present under /var/metrics_conf path Default value: NS_S_ANALYTICS_DEFAULT_SCHEMA_FILE Maximum value: 64
metricsExportFrequency This option is for configuring the metrics export frequency in seconds, frequency value must be in [30,300] seconds range Default value: 30 Minimum value: 30 Maximum value: 300
metricsAuthToken
Token for authenticating with the endpoint. If the endpoint requires the Authorization header in a particular format, specify the complete format as the value to this parameter. For eg., in case of splunk, the Authorizaiton header is required to be of the form - Splunk
metricsEndpointUrl The URL at which to upload the metrics data on the endpoint Maximum value: 256
Example
set metrics profile metrics_profile1 -collector
unset metrics profile
Use this command to remove metrics profile settings.Refer to the set metrics profile command for meanings of the arguments.
Synopsis
unset metrics profile
rm metrics profile
Removes an metrics profile.
Synopsis
rm metrics profile
Arguments
name Name of the profile to remove.
Example
rm metrics profile metrics_profile1
show metrics profile
Displays information about all configured metrics profiles, or about the specified profile.
Synopsis
show metrics profile [
Arguments
name Name of the profile about which to display information.
Output
collector The collector should be a HTTP/HTTPS service.
refCnt The number of references to the profile.
outputMode This option indicates the format in which metrics data is generated
metrics This option is used enable or disable metrics
serveMode This option is to configure metrics pull or push mode. In push mode metricscollector exports metrics to configured collector. In pull mode, metricscollector only generates the metrics which will be pulled by external agent. No collector configuration is required in pull mode and it is applicable only for output mode Prometheus
schemaFile This option is for configuring json schema file containing a list of counters to be exported by metricscollector. Schema file should be present under /var/metrics_conf path
metricsExportFrequency This option is for configuring the metrics export frequency in seconds, frequency value must be in [30,300] seconds range
metricsAuthToken
Token for authenticating with the endpoint. If the endpoint requires the Authorization header in a particular format, specify the complete format as the value to this parameter. For eg., in case of splunk, the Authorizaiton header is required to be of the form - Splunk
metricsEndpointUrl The URL at which to upload the metrics data on the endpoint
entityType Type of the entity bound to the metrics profile.
entityName Name of the entity bound to the metrics profile.
stateflag devno count _nextgenAPIResource
Example
show metrics profile prof1
bind metrics profile
Bind entities to metrics profile.
Synopsis
bind metrics profile
Arguments
name Name for the metrics profile. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.!
entityName Name of the entity bound to the metrics profile.
entityType Type of the entity bound to the metrics profile.
Possible values: lbvserver, csvserver, crvserver, vpnvserver, authvserver, gslbvserver, uservserver, service, servicegroup
unbind metrics profile
Unbind entities from metrics profile.
Synopsis
unbind metrics profile
Arguments
name Name for the metrics profile. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.!
entityName Name of the entity bound to the metrics profile.
entityType Type of the entity bound to the metrics profile.
Possible values: lbvserver, csvserver, crvserver, vpnvserver, authvserver, gslbvserver, uservserver, service, servicegroup
Share
Share
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.