{"id":13582236,"url":"https://github.com/qiniu/logkit","last_synced_at":"2025-05-15T14:05:11.557Z","repository":{"id":20936398,"uuid":"91304426","full_name":"qiniu/logkit","owner":"qiniu","description":"Very powerful server agent for collecting \u0026 sending logs \u0026 metrics with an easy-to-use web console.","archived":false,"fork":false,"pushed_at":"2024-05-20T05:25:53.000Z","size":26808,"stargazers_count":1359,"open_issues_count":55,"forks_count":258,"subscribers_count":57,"default_branch":"master","last_synced_at":"2025-04-15T03:54:11.718Z","etag":null,"topics":["collector-agent","go","log-collector","logkit","metrics-gathering","pandora"],"latest_commit_sha":null,"homepage":"https://logkit-pro.qiniu.com","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qiniu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":"audit/audit.go","citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-05-15T06:50:40.000Z","updated_at":"2025-04-14T03:00:37.000Z","dependencies_parsed_at":"2024-06-18T19:44:34.413Z","dependency_job_id":"87a1eeb1-2c52-458d-b577-ebfa0bfc45b4","html_url":"https://github.com/qiniu/logkit","commit_stats":{"total_commits":1369,"total_committers":60,"mean_commits":"22.816666666666666","dds":0.674945215485756,"last_synced_commit":"b75db0eb8c8a0f14b12076562668a676ac9c68eb"},"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiniu%2Flogkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiniu%2Flogkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiniu%2Flogkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiniu%2Flogkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qiniu","download_url":"https://codeload.github.com/qiniu/logkit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254355334,"owners_count":22057354,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["collector-agent","go","log-collector","logkit","metrics-gathering","pandora"],"created_at":"2024-08-01T15:02:31.093Z","updated_at":"2025-05-15T14:05:06.541Z","avatar_url":"https://github.com/qiniu.png","language":"Go","funding_links":[],"categories":["开源类库","Go","Open source library","Repositories"],"sub_categories":["日志","Logs"],"readme":"# logkit-community [![Build Status](https://api.travis-ci.org/qiniu/logkit.svg)](http://travis-ci.org/qiniu/logkit) [![Go Report Card](https://goreportcard.com/badge/github.com/qiniu/logkit)](https://goreportcard.com/report/github.com/qiniu/logkit) [![codecov](https://codecov.io/gh/qiniu/logkit/branch/master/graph/badge.svg)](https://codecov.io/gh/qiniu/logkit/branch/master) [![GoDoc](https://godoc.org/github.com/qiniu/logkit?status.svg)](https://godoc.org/github.com/qiniu/logkit)\n\n![logkit LOGO](https://raw.githubusercontent.com/qiniu/logkit/master/resources/logo.png)\n\n[中文版](https://github.com/qiniu/logkit/blob/master/READMECN.md)\n\n## Introduce\n\nVery powerful server agent for collecting \u0026 sending logs \u0026 metrics with an easy-to-use web console.\n\n### logkit-community Detail doc can be referred to[WIKI](https://github.com/qiniu/logkit/wiki)\n\n## Support sources\n\n* [File](https://github.com/qiniu/logkit/wiki/File-Reader): read data in file, including csv file，kafka-rest log，nginx log.\n* [Elasticsearch](https://github.com/qiniu/logkit/wiki/ElasticSearch-Reader): read data in ElasticSearch.\n* [MongoDB](https://github.com/qiniu/logkit/wiki/MongoDB-Reader): read data in MongoDB.\n* [MySQL](https://github.com/qiniu/logkit/wiki/MySQL-Reader): read data in MySQL.\n* [MicroSoft SQL Server](https://github.com/qiniu/logkit/wiki/MicroSoft-SQL-Server-Reader): read data in Microsoft SQL Server.\n* [Postgre SQL](https://github.com/qiniu/logkit/wiki/PostgreSQL-Reader): read data in PostgreSQL.\n* [Kafka](https://github.com/qiniu/logkit/wiki/Kafka-Reader): read data in Kafka.\n* [Redis](https://github.com/qiniu/logkit/wiki/Redis-Reader): read data in Redis.\n* [Socket](https://github.com/qiniu/logkit/wiki/Socket-Reader): read data via tcp\\udp\\unixsocket protocol.\n* [Http](https://github.com/qiniu/logkit/wiki/Http-Reader): reveive data in post request as http server.\n* [Script](https://github.com/qiniu/logkit/wiki/Script-Reader): support script and read data from the result.\n* [Snmp](https://github.com/qiniu/logkit/wiki/Snmp-Reader): auto read data from Snmp service.\n\n## Working method\n\nlogkit-community support multiple sources and can send kinds of data to Pandora, every data source relevant to a logic runner,a runner's workaround as follows:\n\n![logkit workaround](https://raw.githubusercontent.com/qiniu/logkit/master/resources/logkit.png)\n\n## Contributing\n\nWeclome to contribute to logkit:\n\n* fix or [report bug](https://github.com/qiniu/logkit/issues/new)\n* [pull issue](https://github.com/qiniu/logkit/issues/new) improve [wiki doc](https://github.com/qiniu/logkit/wiki)\n* [review code](https://github.com/qiniu/logkit/pulls) or [create issues](https://github.com/qiniu/logkit/issues/new)\n* contribute code (contribute kinds of modules including [reader](https://github.com/qiniu/logkit/wiki/Readers)、[parser](https://github.com/qiniu/logkit/wiki/Parsers)、[sender](https://github.com/qiniu/logkit/wiki/Senders) and [transformer](https://github.com/qiniu/logkit/wiki/Transformers)）\n\n## Download\n\n**lastest stable**：Go to [Download page](https://github.com/qiniu/logkit/wiki/Download)\n\n**History**：Go to [Releases](https://github.com/qiniu/logkit/releases)\n\n**Trial**：construct lastest logkit trial version every 5:00am (only for Linux 64 and Docker), you can download it (note: not include update of frontend).\n\n* [Linux 64 download](https://pandora-dl.qiniu.com/nightly/logkit_nightly.tar.gz)\n\n* Docker image nightly:  `docker pull wonderflow/logkit:nightly`\n\n## Install and Usage\n\n### 1. Download\u0026Decompress logkit-community tool\n\n* Linux\n\n``` sh\nexport LOGKIT_VERSION=\u003cversion number\u003e\nwget https://pandora-dl.qiniu.com/logkit_${LOGKIT_VERSION}.tar.gz \u0026\u0026 tar xvf logkit_${LOGKIT_VERSION}.tar.gz \u0026\u0026 rm logkit_${LOGKIT_VERSION}.tar.gz \u0026\u0026 cd _package_linux64/\n```\n\n* MacOS\n\n``` sh\nexport LOGKIT_VERSION=\u003cversion number\u003e\nwget https://pandora-dl.qiniu.com/logkit_mac_${LOGKIT_VERSION}.tar.gz \u0026\u0026 tar xvf logkit_mac_${LOGKIT_VERSION}.tar.gz \u0026\u0026 rm logkit_mac_${LOGKIT_VERSION}.tar.gz \u0026\u0026 cd _package_mac/\n```\n\n* Windows\n\nplease download `https://pandora-dl.qiniu.com/logkit_windows_\u003cLOGKIT_VERSION\u003e.zip` 并解压缩，go to directory\n\n### 2. change logkit-community configuration\n\nlogkit.conf is logkit-community tool's configuration，mainly for specifing running resource and paths of runners.\n\nOpen `logkit.conf`, for example：\n\n``` json\n{\n    \"max_procs\": 8,\n    \"debug_level\": 1,\n    \"clean_self_log\":true,\n    \"bind_host\":\"localhost:3000\",\n    \"static_root_path\":\"./public\",\n    \"confs_path\": [\"confs*\"]\n}\n```\n\nFor simply use, you can only focus on three options:\n\n1. `bind_host` port of logkit we。\n1. `static_root_path` statistic resource path of logkit page, **recommand to use absolute path** note：old version moved to \"public-old\" directory。\n1. `confs_path` including add conf in web, logkit also support monitor directory to add runners. (if you only need to add logkit runner in web, you can ignore this option)\n\n\n### 3. startup logkit-community tool\n\n``` sh\n./logkit -f logkit.conf\n```\n\n### 4. Open logkit-community config page in web\n\nthe web url is the value of `bind_host` configured in step 2\n\n## Contribute frontend code\n\nrefer to README file：[logkitweb/README.md](https://github.com/qiniu/logkit/blob/master/logkitweb/README.md)\n\n## Install and startup from source code\n\n``` sh\ngo build -o logkit logkit.go\n./logkit -f logkit.conf\n```\n\n## startup logkit using docker\n\n``` sh\ndocker pull wonderflow/logkit:\u003cversion\u003e\ndocker run -d -p 3000:3000 -v /local/logkit/dataconf:/app/confs -v /local/log/path:/logs/path logkit:\u003cversion\u003e\n```\n\n## Deploying logkit in Kubernetes\n\nget configs deploying in Kubernetes\n\n``` sh\ncurl -L -O https://raw.githubusercontent.com/qiniu/logkit/master/deploy/logkit_on_k8s.yaml\n```\n\nenjoy it！\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqiniu%2Flogkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqiniu%2Flogkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqiniu%2Flogkit/lists"}