move project to github

Dockerfile

@@ -0,0 +1,14 @@
+FROM harbor.dds-sysu.tech/ebpf_env/ebpf_env:latest as builder
+WORKDIR /build
+COPY deployment ./deployment
+RUN bash ./deployment/script/install_go.sh
+COPY . .
+ENV PATH="/usr/local/go/bin:${PATH}"
+RUN make
+
+
+FROM harbor.dds-sysu.tech/ebpf_env/ebpf_env:latest
+WORKDIR ./ebpf
+COPY --from=builder /build/release .
+RUN ls
+ENTRYPOINT ["./kmon"]

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 Weng Tianjun
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Makefile

@@ -0,0 +1,21 @@
+RELEASE_PATH ?= ./release
+
+.PHONY: clean
+
+all: monitor obj
+
+test: monitor
+	cd release && ./kmon
+
+monitor:
+	go build -o $(RELEASE_PATH)/kmon src/main.go
+
+obj:
+	make -C ebpf all
+
+docker:
+	docker build -t kmon:latest .
+
+clean:
+	rm $(RELEASE_PATH)/kmon
+	make -C ebpf clean

README.md

@@ -0,0 +1,63 @@
+# Kmon
+Implementation of paper [Kmon: An In-kernel Transparent Monitoring System
+for Microservice Systems with eBPF]()
+
+Kmon support some in-kernel indicator with different granularity.
+
+## Screenshot
+![Tcpdrop Snapshot](images/tcpdrop_snapshot.png)
+This exmample shows information such as packet details, socket state, and kernel packets/segments stack trace for dropped via tcp_drop(See [tcpdrop](https://github.com/iovisor/bcc/blob/master/tools/tcpdrop.py) in BCC). Kmon collect these infomation from program and export them to database.
+
+The configuration of this example is like this.
+
+```yaml
+exporter:
+  influxdb:
+    - name: influx
+      host: http://192.168.199.123:8086
+
+collector:
+  tcpdrop:
+    - name: tcp_drop
+      # ~1: drop_event
+      # 2 : drop_event, user_stack
+      # 3~: drop_event, user_stack, kernel_stack
+      verbose: 3
+
+      listen:
+        # Regular expression to filter container
+        # With format:[namespace]/[container name]
+        k8s:
+          - ".+/*"
+
+      export:
+        period: 1000
+        data_name: tcpdrop
+        exporter:
+          - name: influx
+            database: metrics
+
+```
+
+User can chose different verbose level, and configuration can be change dynamically by replace config file(not support add new and delete collector temporary).
+
+See [Config Examples](deployment/config_example) for more configuration example.
+
+## Collector
+biostat: Trace latency and throughput of container and device.
+fcount: Count the number of specific kernel function execution.
+offcpu: Summarize off-CPU time by kernel stack or user stack trace.
+tcpdrop: Trace kernel-based TCP packet drops with details.
+tcpreq: Trace request by TCP packet for each container.
+
+## Compile
+# Docker
+```bash
+docker build .
+```
+Folder [deployment/kubernetes](deployment/kubernetes) shows an example to deploy Kmon in kubernetes.
+# Binary
+You should install [BCC](https://github.com/iovisor/bcc) and [golang](https://golang.google.cn/) befor compile.
+```
+make
+```

database.sh

@@ -0,0 +1,16 @@
+
+# https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html
+docker run -d -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" docker.elastic.co/elasticsearch/elasticsearch:7.10.0
+
+# https://hub.docker.com/_/influxdb/
+docker run -d -p 8086:8086 \
+      -v influxdb:/var/lib/influxdb \
+      influxdb
+
+# https://grafana.com/docs/grafana/latest/installation/docker/
+docker run -d -p 3000:3000 --name grafana grafana/grafana:6.5.0
+
+# https://www.elastic.co/guide/en/kibana/current/docker.html
+DOCKER_REPO=docker.elastic.co/kibana/kibana
+DOCKER_VERSION=7.10.2
+docker run -d --link $(docker ps| grep elasticsearch | awk '{print $1}'):elasticsearch -p 5601:5601 $DOCKER_REPO:$DOCKER_VERSION

deployment/config_example/biostat.yaml

@@ -0,0 +1,23 @@
+exporter:
+  influxdb:
+    - name: influx
+      host: http://192.168.199.123:8086
+
+collector:
+  biostat:
+    - name: block_io_state
+      # ~1: total_IO_byte, total_latency
+      # 2~: total_IO_byte, total_latency, IO_latency_hist
+      verbose: 2
+      bin_scale: 1000 # bin_id = [log2(latency(ns)/bin_scale)]
+
+      listen:
+        pid:
+          - 385
+
+      export:
+        period: 1000
+        data_name: biostat
+        exporter:
+          - name: influx
+            database: metrics

deployment/config_example/fcount.yaml

@@ -0,0 +1,23 @@
+exporter:
+  influxdb:
+    - name: influx
+      host: http://192.168.199.123:8086
+
+collector:
+  fcount:
+    - name: write_counter
+      function: __x64_sys_write
+      count_return: false
+
+      listen:
+        # regular expression to filter container
+        # with format:[namespace]/[container name]
+        k8s:
+          - hipster/*
+
+      export:
+        period: 1000
+        data_name: fcount
+        exporter:
+          - name: influx
+            database: metrics

deployment/config_example/offcpu.yaml

@@ -0,0 +1,29 @@
+exporter:
+  influxdb:
+    - name: influx
+      host: http://192.168.199.123:8086
+
+collector:
+  offcpu:
+    - name: off_cpu_time
+      # ~1: time_hist
+      # 2 : time_hist, kernel_stack
+      # 3~: time_hist, kernel_stack, user_stack,
+      verbose: 2
+      # filter on state bitmask (eg, 2 == TASK_UNINTERRUPTIBLE")
+      # see include/linux/sched.h"
+      state: 3
+      # filter on time, only record event with time(us) in (time_start, time_end)
+      time_start: 1
+      time_end: 10000
+
+      listen:
+        pid:
+          - 19286
+
+      export:
+        period: 1000
+        data_name: offcpu
+        exporter:
+          - name: influx
+            database: metrics