flags.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226
  1. package flags
  2. import (
  3. "fmt"
  4. "net/url"
  5. "os"
  6. "strings"
  7. "github.com/common-nighthawk/go-figure"
  8. "gopkg.in/alecthomas/kingpin.v2"
  9. "gopkg.in/ini.v1"
  10. )
  11. var (
  12. // apm
  13. ConfigServer = kingpin.Flag("config-server", "The URL of the endpoint to send traces to").Envar("CONFIG_SERVER").Default("").String()
  14. DataServer = kingpin.Flag("data-server", "The URL of the endpoint to send traces to").Envar("DATA_SERVER").Default("").String()
  15. DumpApps = kingpin.Flag("dump", "Dump app snap").Short('d').Default("false").Bool()
  16. DumpRules = kingpin.Flag("dr", "Dump rule snap").Default("false").Bool()
  17. PrintFormat = kingpin.Flag("output", "Output format (table|json)").Short('o').Default("table").String()
  18. Version = kingpin.Flag("version", "show app version").Short('v').Bool()
  19. LogLevel = kingpin.Flag("log-level", "Log level").Envar("LOG_LEVEL").Default("").String()
  20. ConsoleLog = kingpin.Flag("console-log", "Console log").Envar("CONSOLE_LOG").Default("false").Bool()
  21. EbpfFilePath = kingpin.Flag("ebpf-path", "Set ebpf file path").Envar("EBPF_FILE").Default("").String()
  22. CommonIni = kingpin.Flag("common.ini", "Set ebpf file path").Envar("COMMON_INI").Default("/opt/apm/euspace/conf/common.ini").String()
  23. ServerPrefix = kingpin.Flag("server-prefix", "server-prefix").Envar("SERVER_PREFIX").Default("").String()
  24. DisableRegisterHost = kingpin.Flag("disable-reg-host", "Disable reg host").Default("false").Envar("DISABLE_REG_HOST").Bool()
  25. // agent
  26. DisableE2ETracing = kingpin.Flag("disable-e2e-tracing", "Disable e2e tracing").Default("true").Envar("DISABLE_E2E_TRACING").Bool()
  27. DisableStackTracing = kingpin.Flag("disable-stack-tracing", "Disable stack tracing").Default("true").Envar("DISABLE_STACK_TRACING").Bool()
  28. LicenseKey = kingpin.Flag("license-key", "Apm API key").Default("J45Engw88NeHUZ4Q7qNsK8L47FTH**QvgW113IEnsNaBNMR5zZ**oj/g!!!!").Envar("LICENSE_KEY").String()
  29. RunInContainer = kingpin.Flag("run-in-container", "run in container").Default("false").Envar("RUN_IN_CONTAINER").Bool()
  30. RunInOmniagent = kingpin.Flag("run-in-omniagent", "run in omniagent").Default("false").Envar("RUN_IN_OMNIAGENT").Bool()
  31. ListenAddress = kingpin.Flag("listen", "Listen address - ip:port or :port").Default("0.0.0.0:8123").Envar("LISTEN").String()
  32. CgroupRoot = kingpin.Flag("cgroupfs-root", "The mount point of the host cgroupfs root").Default("/sys/fs/cgroup").Envar("CGROUPFS_ROOT").String()
  33. DisableLogParsing = kingpin.Flag("disable-log-parsing", "Disable container log parsing").Default("true").Envar("DISABLE_LOG_PARSING").Bool()
  34. DisablePinger = kingpin.Flag("disable-pinger", "Don't ping upstreams").Default("false").Envar("DISABLE_PINGER").Bool()
  35. DisableL7Tracing = kingpin.Flag("disable-l7-tracing", "Disable L7 tracing").Default("false").Envar("DISABLE_L7_TRACING").Bool()
  36. EnableElasticsearchDetection = kingpin.Flag("enable-es", "Enable Elasticsearch detection in HTTP requests").Default("false").Envar("ENABLE_ES").Bool()
  37. ExternalNetworksWhitelist = kingpin.
  38. Flag("track-public-network", "Allow track connections to the specified IP networks, all private networks are allowed by default (e.g., Y.Y.Y.Y/mask)").
  39. Envar("TRACK_PUBLIC_NETWORK").
  40. Default("0.0.0.0/0").
  41. Strings()
  42. EphemeralPortRange = kingpin.Flag("ephemeral-port-range", "Destination and Listen TCP ports from this range will be skipped").Default("").Envar("EPHEMERAL_PORT_RANGE").String()
  43. Provider = kingpin.Flag("provider", "`provider` label for `node_cloud_info` metric").Envar("PROVIDER").String()
  44. Region = kingpin.Flag("region", "`region` label for `node_cloud_info` metric").Envar("REGION").String()
  45. AvailabilityZone = kingpin.Flag("availability-zone", "`availability_zone` label for `node_cloud_info` metric").Envar("AVAILABILITY_ZONE").String()
  46. InstanceType = kingpin.Flag("instance-type", "`instance_type` label for `node_cloud_info` metric").Envar("INSTANCE_TYPE").String()
  47. InstanceLifeCycle = kingpin.Flag("instance-life-cycle", "`instance_life_cycle` label for `node_cloud_info` metric").Envar("INSTANCE_LIFE_CYCLE").String()
  48. LogPerSecond = kingpin.Flag("log-per-second", "The number of logs per second").Default("10.0").Envar("LOG_PER_SECOND").Float64()
  49. LogBurst = kingpin.Flag("log-burst", "The maximum number of tokens that can be consumed in a single call to allow").Default("100").Envar("LOG_BURST").Int()
  50. CollectorEndpoint = kingpin.Flag("collector-endpoint", "A base endpoint URL for metrics, traces, logs, and profiles").Envar("COLLECTOR_ENDPOINT").URL()
  51. ApiKey = kingpin.Flag("api-key", "Coroot API key").Envar("API_KEY").String()
  52. MetricsEndpoint = kingpin.Flag("metrics-endpoint", "The URL of the endpoint to send metrics to").Envar("METRICS_ENDPOINT").URL()
  53. TracesEndpoint = kingpin.Flag("traces-endpoint", "The URL of the endpoint to send traces to").Envar("TRACES_ENDPOINT").URL()
  54. LogsEndpoint = kingpin.Flag("logs-endpoint", "The URL of the endpoint to send logs to").Envar("LOGS_ENDPOINT").URL()
  55. ProfilesEndpoint = kingpin.Flag("profiles-endpoint", "The URL of the endpoint to send profiles to").Envar("PROFILES_ENDPOINT").URL()
  56. InsecureSkipVerify = kingpin.Flag("insecure-skip-verify", "whether to skip verifying the certificate or not").Envar("INSECURE_SKIP_VERIFY").Default("false").Bool()
  57. TracesCompression = kingpin.Flag("traces-compression", "Compression algorithm for traces (none|gzip|zstd)").Envar("TRACES_COMPRESSION").Default("zstd").String()
  58. ScrapeInterval = kingpin.Flag("scrape-interval", "How often to gather metrics from the agent").Default("15s").Envar("SCRAPE_INTERVAL").Duration()
  59. WalDir = kingpin.Flag("wal-dir", "Path to where the agent stores data (e.g. the metrics Write-Ahead Log)").Default("/tmp/coroot-node-agent").Envar("WAL_DIR").String()
  60. HostDirPathPrefix = kingpin.Flag("host-dir-path-prefix", "Set the prefix of path about the mount point of the host directory").Envar("HOST_DIR_PATH_PREFIX").Default("").String()
  61. FuseTryMax = kingpin.Flag("fuse_try_max", "The maximum number of the fuse operation try").Default("3").Envar("FUSE_TRY_MAX").Int()
  62. // debug
  63. Test = kingpin.Flag("test", "Only test").Default("false").Envar("TEST").Bool()
  64. // op 新增配置
  65. SysTag = kingpin.Flag("sys-tag", "sys tag").Envar("APM_SYS").Default("").String()
  66. // l7
  67. MysqlDefault = kingpin.Flag("mysql-default", "Default MySQL protocol when port-based detection fails").Envar("MYSQL_DEFAULT").Default("mysql").String()
  68. // 端口白名单配置
  69. MysqlPortWhitelist = kingpin.Flag("mysql-ports", "Comma-separated list of ports to identify as MySQL").Envar("MYSQL_PORTS").Default("").String()
  70. MariadbPortWhitelist = kingpin.Flag("mariadb-ports", "Comma-separated list of ports to identify as MariaDB").Envar("MARIADB_PORTS").Default("").String()
  71. TidbPortWhitelist = kingpin.Flag("tidb-ports", "Comma-separated list of ports to identify as TiDB").Envar("TIDB_PORTS").Default("").String()
  72. //APP注册到DOOP
  73. RegisterAppToDoop = kingpin.Flag("register-app-to-doop", "Register the app-info to the doop").Default("false").Envar("REGISTER_APP_TO_DOOP").Bool()
  74. //是否向平台发送网络数据
  75. SendNetData = kingpin.Flag("send-net-data", "Send the net data to platform").Default("false").Envar("SEND_NET_DATA").Bool()
  76. //是否开启License校验逻辑
  77. EnableLicenseCheck = kingpin.Flag("enable-license-check", "Enable license check and quota validation").Default("true").Envar("ENABLE_LICENSE_CHECK").Bool()
  78. //配置文件路径
  79. ConfigFile = kingpin.Flag("config", "Path to configuration file").Envar("EUSPACE_CONFIG").Default("").String()
  80. )
  81. var AgentName = "euspace"
  82. var AgentVersion = "0.0.1"
  83. var GitCommit = ""
  84. var BuildDate = ""
  85. func GetString(fl *string) string {
  86. if fl == nil {
  87. return ""
  88. }
  89. return *fl
  90. }
  91. func init() {
  92. if strings.HasSuffix(os.Args[0], ".test") {
  93. return
  94. }
  95. kingpin.HelpFlag.Short('h').Hidden()
  96. kingpin.Parse()
  97. if *Test {
  98. euspace := figure.NewFigure("TEST", "", true)
  99. // 只在用户未显式设置时才应用 test 模式的默认值
  100. if os.Getenv("DISABLE_REG_HOST") == "" {
  101. *DisableRegisterHost = true
  102. }
  103. if os.Getenv("DISABLE_E2E_TRACING") == "" {
  104. *DisableE2ETracing = false
  105. }
  106. *ConsoleLog = true
  107. *LogLevel = "debug"
  108. *EnableLicenseCheck = false
  109. euspace.Print()
  110. } else {
  111. euspace := figure.NewColorFigure("Euspace", "slant", "blue", true)
  112. euspace.Print()
  113. }
  114. if *Version {
  115. ShowVersion()
  116. }
  117. if *DumpApps {
  118. DumpTableFeatures(*PrintFormat)
  119. }
  120. if *DumpRules {
  121. DumpRuleTableFeatures(*PrintFormat)
  122. }
  123. if *CollectorEndpoint != nil {
  124. u := *CollectorEndpoint
  125. if *MetricsEndpoint == nil {
  126. *MetricsEndpoint = u.JoinPath("/v1/metrics")
  127. }
  128. if *TracesEndpoint == nil {
  129. *TracesEndpoint = u.JoinPath("/v1/traces")
  130. }
  131. if *LogsEndpoint == nil {
  132. *LogsEndpoint = u.JoinPath("/v1/logs")
  133. }
  134. if *ProfilesEndpoint == nil {
  135. *ProfilesEndpoint = u.JoinPath("/v1/profiles")
  136. }
  137. }
  138. if *MetricsEndpoint != nil {
  139. *ListenAddress = "127.0.0.1:10300"
  140. }
  141. // set ServerPrefix
  142. // set ConfigServer
  143. // set DataServer
  144. // 注意:ConfigServer 和 DataServer 的最高优先级是 common.ini(如果 RunInOmniagent 为 true)
  145. // 这个逻辑在 flags.go 的 init() 中执行,确保在 Viper 配置加载之前就设置了
  146. if *RunInOmniagent {
  147. // omni 模式下,account_id 从 common.ini 的 token 解析,不需要通过 RegisterHost 获取
  148. if os.Getenv("DISABLE_REG_HOST") == "" {
  149. *DisableRegisterHost = true
  150. }
  151. iniData, err := ini.Load(*CommonIni)
  152. if err == nil && iniData != nil {
  153. *ServerPrefix = "/apm"
  154. configServer := iniData.Section("common").Key("config_server").String()
  155. dataServer := iniData.Section("common").Key("data_server").String()
  156. if configServer != "" {
  157. *ConfigServer = configServer
  158. }
  159. if dataServer != "" {
  160. *DataServer = dataServer
  161. }
  162. }
  163. }
  164. // set TracesEndpoint
  165. if *TracesEndpoint == nil && *DataServer != "" {
  166. if !strings.HasPrefix(*DataServer, "http") {
  167. *DataServer = fmt.Sprintf("http://%s", *DataServer)
  168. }
  169. dataServer, err := url.Parse(*DataServer)
  170. if err == nil && dataServer != nil {
  171. *TracesEndpoint = dataServer.JoinPath(*ServerPrefix + "/api/v2/data/receive")
  172. }
  173. }
  174. // set tiny-agent config
  175. //nativeConf := utils.GetDefaultAgentsPath("NativeAgent", "conf", "agent.properties")
  176. //confData, err := ini.Load(nativeConf)
  177. //if err == nil {
  178. // configServer := *ConfigServer
  179. // if !strings.HasPrefix(*ConfigServer, "http") {
  180. // configServer = fmt.Sprintf("http://%s", *ConfigServer)
  181. // }
  182. // confData.Section(ini.DEFAULT_SECTION).Key("ConfigDomain").SetValue(configServer + *ServerPrefix)
  183. // confData.Section(ini.DEFAULT_SECTION).Key("SendDomain").SetValue(*DataServer + *ServerPrefix)
  184. // err = confData.SaveTo(nativeConf)
  185. // if err != nil {
  186. // klog.Error(err)
  187. // }
  188. //}
  189. if *RunInContainer {
  190. if *HostDirPathPrefix == "" {
  191. *HostDirPathPrefix = "/host"
  192. }
  193. } else {
  194. *HostDirPathPrefix = ""
  195. }
  196. // 初始化端口白名单
  197. InitPortWhitelists()
  198. }
  199. func ShowVersion() {
  200. fmt.Printf("%-20s %-8s\n", "Name:", AgentName)
  201. fmt.Printf("%-20s %-8s\n", "Version:", AgentVersion)
  202. fmt.Printf("%-20s %-8s\n", "Commit:", GitCommit)
  203. fmt.Printf("%-20s %-8s\n", "Date:", BuildDate)
  204. os.Exit(0)
  205. }