diff --git a/Makefile b/Makefile index 9e0d46f..b2b9eb1 100644 --- a/Makefile +++ b/Makefile @@ -5,8 +5,8 @@ APP:=categraf ROOT:=$(shell pwd -P) GIT_COMMIT:=$(shell git --work-tree ${ROOT} rev-parse 'HEAD^{commit}') _GIT_VERSION:=$(shell git --work-tree ${ROOT} describe --tags --abbrev=14 "${GIT_COMMIT}^{commit}" 2>/dev/null) -GIT_VERSION:=$(shell echo "${_GIT_VERSION}"| sed "s/-g\([0-9a-f]\{14\}\)$$/+\1/") -TAR_TAG:=$(shell echo ${GIT_VERSION}| awk -F"-" '{print $$1}') +TAG=$(shell echo "${_GIT_VERSION}" | awk -F"-" '{print $$1}') +GIT_VERSION:="$(TAG)-$(GIT_COMMIT)" BUILD_VERSION:='flashcat.cloud/categraf/config.Version=$(GIT_VERSION)' LDFLAGS:="-w -s -X $(BUILD_VERSION)" @@ -19,6 +19,7 @@ build: echo "Building version $(GIT_VERSION)" go build -ldflags $(LDFLAGS) -o $(APP) + build-linux: echo "Building version $(GIT_VERSION) for linux" GOOS=linux GOARCH=amd64 go build -ldflags $(LDFLAGS) -o $(APP) @@ -31,8 +32,12 @@ build-mac: echo "Building version $(GIT_VERSION) for mac" GOOS=darwin GOARCH=amd64 go build -ldflags $(LDFLAGS) -o $(APP).mac +build-image: build-linux + echo "Building image flashcatcloud/categraf:$(TAG)" + cp -f categraf docker/ && cd docker && docker build -t flashcatcloud/categraf:$(TAG) . + pack:build-linux build-windows - rm -rf $(APP)-$(TAR_TAG).tar.gz - rm -rf $(APP)-$(TAR_TAG).zip - tar -zcvf $(APP)-$(TAR_TAG)-linux-amd64.tar.gz conf $(APP) - zip -r $(APP)-$(TAR_TAG)-windows-amd64.zip conf $(APP).exe + rm -rf $(APP)-$(TAG).tar.gz + rm -rf $(APP)-$(TAG).zip + tar -zcvf $(APP)-$(TAG)-linux-amd64.tar.gz conf $(APP) + zip -r $(APP)-$(TAG)-windows-amd64.zip conf $(APP).exe diff --git a/docker/Dockerfile b/docker/Dockerfile new file mode 100644 index 0000000..080f70a --- /dev/null +++ b/docker/Dockerfile @@ -0,0 +1,14 @@ +FROM alpine:3.15 + +RUN echo 'hosts: files dns' >> /etc/nsswitch.conf +RUN apk add --no-cache iputils ca-certificates net-snmp-tools procps lm_sensors tzdata su-exec libcap wget tar libc6-compat file && \ + update-ca-certificates + +RUN set -ex && \ + mkdir -p /usr/bin /etc/categraf + +COPY conf /etc/categraf/conf +COPY categraf /usr/bin/categraf + +COPY entrypoint.sh /entrypoint.sh +CMD ["/entrypoint.sh"] diff --git a/docker/categraf b/docker/categraf new file mode 100755 index 0000000..99052ad Binary files /dev/null and b/docker/categraf differ diff --git a/docker/conf/config.toml b/docker/conf/config.toml new file mode 100644 index 0000000..5526bb3 --- /dev/null +++ b/docker/conf/config.toml @@ -0,0 +1,45 @@ +[global] +# whether print configs +print_configs = false + +# add label(agent_hostname) to series +# "" -> auto detect hostname +# "xx" -> use specified string xx +# "$hostname" -> auto detect hostname +# "$ip" -> auto detect ip +# "$hostname-$ip" -> auto detect hostname and ip to replace the vars +hostname = "$HOSTNAME" + +# will not add label(agent_hostname) if true +omit_hostname = false + +# s | ms +precision = "ms" + +# global collect interval +interval = 15 + +[global.labels] +source="categraf" +# region = "shanghai" +# env = "localhost" + +[writer_opt] +# default: 2000 +batch = 2000 +# channel(as queue) size +chan_size = 10000 + +[[writers]] +url = "http://nightingale-nserver/prometheus/v1/write" + +# Basic auth username +basic_auth_user = "" + +# Basic auth password +basic_auth_pass = "" + +# timeout settings, unit: ms +timeout = 5000 +dial_timeout = 2500 +max_idle_conns_per_host = 100 diff --git a/docker/conf/input.cpu/cpu.toml b/docker/conf/input.cpu/cpu.toml new file mode 100644 index 0000000..50d511a --- /dev/null +++ b/docker/conf/input.cpu/cpu.toml @@ -0,0 +1,5 @@ +# # collect interval +# interval = 15 + +# # whether collect per cpu +# collect_per_cpu = false diff --git a/docker/conf/input.disk/disk.toml b/docker/conf/input.disk/disk.toml new file mode 100644 index 0000000..72f2563 --- /dev/null +++ b/docker/conf/input.disk/disk.toml @@ -0,0 +1,11 @@ +# # collect interval +# interval = 15 + +# # By default stats will be gathered for all mount points. +# # Set mount_points will restrict the stats to only the specified mount points. +# mount_points = ["/"] + +# Ignore mount points by filesystem type. +ignore_fs = ["tmpfs", "devtmpfs", "devfs", "iso9660", "overlay", "aufs", "squashfs"] + +ignore_mount_points = ["/boot"] diff --git a/docker/conf/input.diskio/diskio.toml b/docker/conf/input.diskio/diskio.toml new file mode 100644 index 0000000..2ed9d56 --- /dev/null +++ b/docker/conf/input.diskio/diskio.toml @@ -0,0 +1,6 @@ +# # collect interval +# interval = 15 + +# # By default, categraf will gather stats for all devices including disk partitions. +# # Setting devices will restrict the stats to the specified devices. +# devices = ["sda", "sdb", "vd*"] \ No newline at end of file diff --git a/docker/conf/input.docker/docker.toml b/docker/conf/input.docker/docker.toml new file mode 100644 index 0000000..c2d44d0 --- /dev/null +++ b/docker/conf/input.docker/docker.toml @@ -0,0 +1,63 @@ +# # collect interval +# interval = 15 + +[[instances]] +# # append some labels for series +# labels = { region="cloud", product="n9e" } + +# # interval = global.interval * interval_times +# interval_times = 1 + +## Docker Endpoint +## To use TCP, set endpoint = "tcp://[ip]:[port]" +## To use environment variables (ie, docker-machine), set endpoint = "ENV" +endpoint = "unix:///var/run/docker.sock" + +## Set to true to collect Swarm metrics(desired_replicas, running_replicas) +gather_services = false +gather_extend_memstats = false + +container_id_label_enable = true +container_id_label_short_style = true + +## Containers to include and exclude. Globs accepted. +## Note that an empty array for both will include all containers +container_name_include = [] +container_name_exclude = [] + +## Container states to include and exclude. Globs accepted. +## When empty only containers in the "running" state will be captured. +## example: container_state_include = ["created", "restarting", "running", "removing", "paused", "exited", "dead"] +## example: container_state_exclude = ["created", "restarting", "running", "removing", "paused", "exited", "dead"] +# container_state_include = [] +# container_state_exclude = [] + +## Timeout for docker list, info, and stats commands +timeout = "5s" + +## Specifies for which classes a per-device metric should be issued +## Possible values are 'cpu' (cpu0, cpu1, ...), 'blkio' (8:0, 8:1, ...) and 'network' (eth0, eth1, ...) +## Please note that this setting has no effect if 'perdevice' is set to 'true' +perdevice_include = [] + +## Specifies for which classes a total metric should be issued. Total is an aggregated of the 'perdevice' values. +## Possible values are 'cpu', 'blkio' and 'network' +## Total 'cpu' is reported directly by Docker daemon, and 'network' and 'blkio' totals are aggregated by this plugin. +## Please note that this setting has no effect if 'total' is set to 'false' +total_include = ["cpu", "blkio", "network"] + +## Which environment variables should we use as a tag +##tag_env = ["JAVA_HOME", "HEAP_SIZE"] + +## docker labels to include and exclude as tags. Globs accepted. +## Note that an empty array for both will include all labels as tags +docker_label_include = [] +docker_label_exclude = ["annotation*", "io.kubernetes*", "*description*", "*maintainer*", "*hash", "*author*"] + +## Optional TLS Config +# use_tls = false +# tls_ca = "/etc/telegraf/ca.pem" +# tls_cert = "/etc/telegraf/cert.pem" +# tls_key = "/etc/telegraf/key.pem" +## Use TLS but skip chain & host verification +# insecure_skip_verify = false diff --git a/docker/conf/input.kernel/kernel.toml b/docker/conf/input.kernel/kernel.toml new file mode 100644 index 0000000..b6110f7 --- /dev/null +++ b/docker/conf/input.kernel/kernel.toml @@ -0,0 +1,2 @@ +# # collect interval +# interval = 15 diff --git a/docker/conf/input.kernel_vmstat/kernel_vmstat.toml b/docker/conf/input.kernel_vmstat/kernel_vmstat.toml new file mode 100644 index 0000000..68327a8 --- /dev/null +++ b/docker/conf/input.kernel_vmstat/kernel_vmstat.toml @@ -0,0 +1,124 @@ +# # collect interval +# interval = 15 + +# file: /proc/vmstat +[white_list] +oom_kill = 1 +nr_free_pages = 0 +nr_alloc_batch = 0 +nr_inactive_anon = 0 +nr_active_anon = 0 +nr_inactive_file = 0 +nr_active_file = 0 +nr_unevictable = 0 +nr_mlock = 0 +nr_anon_pages = 0 +nr_mapped = 0 +nr_file_pages = 0 +nr_dirty = 0 +nr_writeback = 0 +nr_slab_reclaimable = 0 +nr_slab_unreclaimable = 0 +nr_page_table_pages = 0 +nr_kernel_stack = 0 +nr_unstable = 0 +nr_bounce = 0 +nr_vmscan_write = 0 +nr_vmscan_immediate_reclaim = 0 +nr_writeback_temp = 0 +nr_isolated_anon = 0 +nr_isolated_file = 0 +nr_shmem = 0 +nr_dirtied = 0 +nr_written = 0 +numa_hit = 0 +numa_miss = 0 +numa_foreign = 0 +numa_interleave = 0 +numa_local = 0 +numa_other = 0 +workingset_refault = 0 +workingset_activate = 0 +workingset_nodereclaim = 0 +nr_anon_transparent_hugepages = 0 +nr_free_cma = 0 +nr_dirty_threshold = 0 +nr_dirty_background_threshold = 0 +pgpgin = 0 +pgpgout = 0 +pswpin = 0 +pswpout = 0 +pgalloc_dma = 0 +pgalloc_dma32 = 0 +pgalloc_normal = 0 +pgalloc_movable = 0 +pgfree = 0 +pgactivate = 0 +pgdeactivate = 0 +pgfault = 0 +pgmajfault = 0 +pglazyfreed = 0 +pgrefill_dma = 0 +pgrefill_dma32 = 0 +pgrefill_normal = 0 +pgrefill_movable = 0 +pgsteal_kswapd_dma = 0 +pgsteal_kswapd_dma32 = 0 +pgsteal_kswapd_normal = 0 +pgsteal_kswapd_movable = 0 +pgsteal_direct_dma = 0 +pgsteal_direct_dma32 = 0 +pgsteal_direct_normal = 0 +pgsteal_direct_movable = 0 +pgscan_kswapd_dma = 0 +pgscan_kswapd_dma32 = 0 +pgscan_kswapd_normal = 0 +pgscan_kswapd_movable = 0 +pgscan_direct_dma = 0 +pgscan_direct_dma32 = 0 +pgscan_direct_normal = 0 +pgscan_direct_movable = 0 +pgscan_direct_throttle = 0 +zone_reclaim_failed = 0 +pginodesteal = 0 +slabs_scanned = 0 +kswapd_inodesteal = 0 +kswapd_low_wmark_hit_quickly = 0 +kswapd_high_wmark_hit_quickly = 0 +pageoutrun = 0 +allocstall = 0 +pgrotated = 0 +drop_pagecache = 0 +drop_slab = 0 +numa_pte_updates = 0 +numa_huge_pte_updates = 0 +numa_hint_faults = 0 +numa_hint_faults_local = 0 +numa_pages_migrated = 0 +pgmigrate_success = 0 +pgmigrate_fail = 0 +compact_migrate_scanned = 0 +compact_free_scanned = 0 +compact_isolated = 0 +compact_stall = 0 +compact_fail = 0 +compact_success = 0 +htlb_buddy_alloc_success = 0 +htlb_buddy_alloc_fail = 0 +unevictable_pgs_culled = 0 +unevictable_pgs_scanned = 0 +unevictable_pgs_rescued = 0 +unevictable_pgs_mlocked = 0 +unevictable_pgs_munlocked = 0 +unevictable_pgs_cleared = 0 +unevictable_pgs_stranded = 0 +thp_fault_alloc = 0 +thp_fault_fallback = 0 +thp_collapse_alloc = 0 +thp_collapse_alloc_failed = 0 +thp_split = 0 +thp_zero_page_alloc = 0 +thp_zero_page_alloc_failed = 0 +balloon_inflate = 0 +balloon_deflate = 0 +balloon_migrate = 0 diff --git a/docker/conf/input.linux_sysctl_fs/linux_sysctl_fs.toml b/docker/conf/input.linux_sysctl_fs/linux_sysctl_fs.toml new file mode 100644 index 0000000..b6110f7 --- /dev/null +++ b/docker/conf/input.linux_sysctl_fs/linux_sysctl_fs.toml @@ -0,0 +1,2 @@ +# # collect interval +# interval = 15 diff --git a/docker/conf/input.mem/mem.toml b/docker/conf/input.mem/mem.toml new file mode 100644 index 0000000..e03d3c9 --- /dev/null +++ b/docker/conf/input.mem/mem.toml @@ -0,0 +1,5 @@ +# # collect interval +# interval = 15 + +# # whether collect platform specified metrics +collect_platform_fields = true diff --git a/docker/conf/input.net/net.toml b/docker/conf/input.net/net.toml new file mode 100644 index 0000000..75aae62 --- /dev/null +++ b/docker/conf/input.net/net.toml @@ -0,0 +1,8 @@ +# # collect interval +# interval = 15 + +# # whether collect protocol stats on Linux +# collect_protocol_stats = false + +# # setting interfaces will tell categraf to gather these explicit interfaces +# interfaces = ["eth0"] \ No newline at end of file diff --git a/docker/conf/input.netstat/netstat.toml b/docker/conf/input.netstat/netstat.toml new file mode 100644 index 0000000..b6110f7 --- /dev/null +++ b/docker/conf/input.netstat/netstat.toml @@ -0,0 +1,2 @@ +# # collect interval +# interval = 15 diff --git a/docker/conf/input.processes/processes.toml b/docker/conf/input.processes/processes.toml new file mode 100644 index 0000000..af7436b --- /dev/null +++ b/docker/conf/input.processes/processes.toml @@ -0,0 +1,8 @@ +# # collect interval +# interval = 15 + +# # force use ps command to gather +# force_ps = false + +# # force use /proc to gather +# force_proc = false \ No newline at end of file diff --git a/docker/conf/input.procstat/procstat.toml b/docker/conf/input.procstat/procstat.toml new file mode 100644 index 0000000..6e98587 --- /dev/null +++ b/docker/conf/input.procstat/procstat.toml @@ -0,0 +1,31 @@ +# # collect interval +# interval = 15 + +# [[instances]] +# # executable name (ie, pgrep ) +# search_exec_substring = "nginx" + +# # pattern as argument for pgrep (ie, pgrep -f ) +# search_cmdline_substring = "n9e server" + +# # windows service name +# search_win_service = "" + +# # append some labels for series +# labels = { region="cloud", product="n9e" } + +# # interval = global.interval * interval_times +# interval_times = 1 + +# # mode to use when calculating CPU usage. can be one of 'solaris' or 'irix' +# mode = "irix" + +# gather_more_metrics = [ +# "threads", +# "fd", +# "io", +# "uptime", +# "cpu", +# "mem", +# "limit" +# ] diff --git a/docker/conf/input.system/system.toml b/docker/conf/input.system/system.toml new file mode 100644 index 0000000..c2b6c73 --- /dev/null +++ b/docker/conf/input.system/system.toml @@ -0,0 +1,5 @@ +# # collect interval +# interval = 15 + +# # whether collect metric: system_n_users +# collect_user_number = false diff --git a/docker/conf/logs.toml b/docker/conf/logs.toml new file mode 100644 index 0000000..a4d8b72 --- /dev/null +++ b/docker/conf/logs.toml @@ -0,0 +1,35 @@ +[logs] +## key 占位符 +api_key = "ef4ahfbwzwwtlwfpbertgq1i6mq0ab1q" +## 是否开启日志采集 +enable = false +## 接受日志的server地址 +send_to = "127.0.0.1:17878" +## 发送日志的协议 http/tcp +send_type = "http" +## 是否压缩发送 +use_compress = false +## 是否采用ssl +send_with_tls = false +## +batch_wait = 5 +## 日志offset信息保存目录 +run_path = "/opt/categraf/run" +## 最多同时采集多少个日志文件 +open_files_limit = 100 +## 定期扫描目录下是否有新增日志 +scan_period = 10 +## +frame_size = 10 +## +collect_container_all = true + ## 全局的处理规则 + [[logs.Processing_rules]] + ## 单个日志采集配置 + [[logs.items]] + ## file/journald + type = "file" + ## type=file时 path必填，type=journald时 port必填 + path = "/opt/tomcat/logs/*.txt" + source = "tomcat" + service = "my_service" diff --git a/docker/entrypoint.sh b/docker/entrypoint.sh new file mode 100755 index 0000000..6ee1d4e --- /dev/null +++ b/docker/entrypoint.sh @@ -0,0 +1,7 @@ +#!/bin/sh +set -e + + # Allow caegraf to send ICMP packets and bind to privliged ports + setcap cap_net_raw,cap_net_bind_service+ep /usr/bin/categraf || echo "Failed to set additional capabilities on /usr/bin/categraf" + + exec /usr/bin/categraf -configs=/etc/categraf/conf