智能日志管理平台

  • 安装

    最近更新时间:2018-11-23 20:10:03

    当前最新版本: v1.2.2

    自动下载安装

    一、 使用七牛账号登录logkit-pro官方网站,点击 <开始使用> ,进入 <机器管理页面>

    二、在 <机器管理> 页面点击 <添加机器>

    三、根据不同操作系统安装

    Linux/Mac 用户安装

    点击 添加机器页面的 <复制地址> 获得如下安装命令:

    其中,您需要将 YOUR_ACCESS_KEY 换成您实际的七牛access_key,将 YOUR_SECRET_KEY 换成您实际的七牛secret_key,将 YOUR_EMAIL 换成您实际的账号邮箱。((在七牛云网站的<个人面板> <秘钥管理>中获取)),替换后您看到的实际命令类似如下:

    注: 若您不执行上述的信息替换,也可以成功安装,命令执行的下载脚本中会带有token鉴权方式,网络通畅的情况下会自动刷新。若网络长时间(超过1个月)中断,则token会过期,导致安装的logkit-pro无法再连接到服务器,替换为您实际的access_key信息后没有该隐患。

    打开一个命令控制台执行上述命令即可安装成功,如下图所示:

    Windows 用户安装

    点击 <下载文件> , 在Windows系统中直接鼠标双击执行,即可安装,如下所示。

    注: 下载的文件会包含access_key等鉴权信息。

    四、下载成功后可以在logkit-pro公有云界面上看到连接过来的机器已经在线

    至此,您已经安装成功,可以开始使用啦。

    自动安装到的本地目录

    Linux用户root权限: /var/local/logkit-pro/agent
    Linux用户非root权限: $HOME/logkit-pro/agent 在当前用户的主目录下。
    Windows用户: C:\logkit-pro\agent
    Mac用户: $HOME/logkit-pro/agent 在当前用户的主目录下。

    对应的日志文件也在安装目录下的logkit.log文件。

    手动下载安装

    注意: 在 0.3.0 及以前的版本只支持手动安装,并且不支持连接到服务器,0.3.0 开始,手动安装的logkit-pro不仅可以单机运行,也可以连到服务器运行。

    Windows 版本 logkit-pro 下载

    windows 64位版本下载

    windows 32位版本下载

    Linux Ubuntu/Debian 版本下载

    linux 64位版本下载

    linux 32位版本下载

    Linux Centos/Redhat 版本下载

    Centos/Redhat 64位版本下载
    Centos/Redhat 32位版本下载

    MacOS 版本下载

    MacOS 版本下载

    启动 logkit-pro

    修改配置文件

    注意,手动安装需要修改配置文件,将配置文件中 agent 模块中的ak、sk部分填写上您实际的七牛ak、sk。

    修改后的配置如图所示:

    直接启动

    在命令控制台(Console), 进入 logkit-pro 所在的文件夹,然后输入(某些版本可能配置文件的名称可能为logkit.conf):

    ./logkit-pro -f logkit-pro.conf
    

    后台启动

    通过命令行进入 logkit-pro 所在的文件夹,然后输入:

    nohup ./logkit-pro -f logkit-pro.conf > logkit.log 2>&1 &
    

    supervisor启动

    我们强烈推荐您使用supervisor管理logkit-pro,具体可以查看文档: 使用supervisor管理logkit-pro

    访问本地 logkit-pro

    启动后,您可以直接打开浏览器访问,默认的端口为 3000 (注意,自动安装的集群版,只能在 https://logkit-pro.qiniu.com 访问,如需两个功能同时启用,可修改本地访问版本配置,下文会有介绍)

    http://127.0.0.1:3000

    logkit首页

    更改 logkit-pro 相关配置

    在本地的 logkit Pro 文件夹里,找到 logkit-Pro.conflogkit-Pro.conf是logkit Pro 的基础配置文件,主要用于指定 logkit Pro 版本信息、服务端信息、机器信息、运行日志等。

    典型的配置如下:

    {
      "version": 1,
      "service": {
        "bind_host": ":3000",
        "static_dir": "public",
        "upload_dir": "data/upload",
        "disable_web": false
      },
      "service_url": {
        "smart_elf": "https://logkit-pro.qiniu.com/"
      },
      "agent": {
        "connect_to_server": false,
        "id_path": "",
        "token_path": "",
        "ak": "",
        "sk": "",
        "token": "",
        "download_token": "",
        "tags": []
      },
      "runtime": {
        "max_procs": 1,
        "pprof_host": ":3002"
      },
      "log": {
        "level": 1,
        "log_path": "",
        "clean_self_log": true,
        "clean_self_dir": "",
        "clean_self_pattern": "",
        "clean_self_cnt": 0,
        "show_routing": false
      },
      "security": {
        "disable_auths": false,
        "auths_file": "auths.conf"
      },
      "confs_path": ["confs*"],
      "time_layouts": []
    }
    
    

    您可以更改配置文件,比如将 127.0.0.1 换成 logkit Pro 所在机器可被访问的 IP 地址,更改bind_host配置项即可。

    若您希望将手动安装的logkit-pro连到logkit-pro公有云统一管理,只需将 connect_to_server 选项改为 true, 并在ak、sk位置填入您对应七牛账号的access_keysecret_key(在七牛云网站的<个人面板> <秘钥管理>中获取)

    修改完成后重新启动即可。对于连接到公有云的agent,您可以直接在 https://logkit-pro.qiniu.com/ 操作您的logkit-pro agent。

    若您只需要通过公有云 https://logkit-pro.qiniu.com/ 对您的agent进行操作,不想占用本地端口,可以把配置文件中的 disable_web 选择设置为 true 再重启。

    其他安装方式

    Docker 镜像版本下载

    docker pull qiniupandora/logkit:v1.2.1
    docker run -d -p 3000:3000 -e QINIU_ACCESS_KEY='修改为您的七牛access_key' -e QINIU_SECRET_KEY='修改为您的七牛secret_key'  -v /local/logkit/meta:/app/meta -v /local/logkit/.logkitconfs:/app/.logkitconfs -v /local/logkit/dataconf:/app/confs -v /local/log/path:/logs/path qiniupandora/logkit:v1.2.1
    

    镜像中的 logkit-pro 收集 /logs 目录下的日志,需要把本地的日志目录也挂载到镜像里面去才能启动,比如本地的日志目录为/local/log/path, 挂载到镜像中的 /logs/path 目录,那么收集器配置中填写的日志路径必须是 /logs/path

    其他如读取socketmysql等,请注意docker启动时的网络模式,选择host模式。

    可能需要挂载的目录如下:

    • /app/confs 这个目录是为了命令行用户准备的,可以通过挂载目录的形式直接往里面放配置文件,热加载,无需页面操作。
    • /app/.logkitconfs 这个目录是服务端或本地WEB页面配置的logkit收集器配置保存的目录。
    • /app/meta 这个目录记录了当前收集器读取的状态,保证数据读取不重不漏。
    • /logs/path 这个目录是您的日志所在目录。

    如果只用WEB界面添加(分发)的配置,可以不挂载 /app/confs

    本地登录【可选功能,自动安装下默认不开启】

    对于手动下载安装的用户,配置文件中默认开启了本地直接登录使用的功能,本地登录可以直接实时拿到本地logkit-pro agent的运行状态,方便排查问题和快速调试。

    我们提供了 2 种登录方式,一种是本地登录,另一种是通过七牛的 access_key、secret_key 登录。

    本地登录

    本地登录

    本地登录的默认用户名和密码都是 admin。

    您可以修改本地 logkit Pro 文件夹中的auth.conf配置文件添加或修改用户名密码。

    注意1: admin 用户可以看到所有用户创建的配置和运行信息,其他用户则只能看到自己的。

    注意2: 本地登录无需外网访问能力

    使用七牛账号 ak、sk 登录

    aksk登录

    您也可以通过 ak、sk 登录,使用七牛的 ak、sk 登录需要可以连通七牛的公有云。

    如果登录不了,在确认ak、sk正确的情况下,请以此检查以下情况:

    1. 机器是否可以访问 https://logkit-pro.qiniu.comping logkit-pro.qiniu.com
    2. 机器的系统时间是否准确,使用ak、sk登录要求机器的时间与服务器鉴权的系统时间相差在15分钟内,请同步机器的时间。

    本地访问 和 连接到公有云的功能区别

    1. 本地访问时,只能控制本地一台机器的 logkit-pro 管理,而公有云版本可以统一管理所有机器的 logkit-pro agent,包括统一下发配置,统一查看运行状态,监控等等。
    2. 启动本地访问配置的logkit-pro会占用一个端口用于提供网页访问的服务,若您使用的是虚拟机,需要打开防火墙端口。而连接到公有云无需占用端口。
    3. 连接到公有云需要在主配置文件中填写access_key/secret_key 或者 token 信息,而本地访问无需填写鉴权信息,默认可以admin登录。
    4. 对于单台机器的采集任务而言,两种使用方式没有区别。
    5. 两种访问方式实际对应的都是同一个程序,只是启动时配置不同。
    6. 两种访问方式可以同时开启,但是对于公有云的配置文件,本地单机访问时只能查看,不能进行修改删除等操作。
    以上内容是否对您有帮助?
  • Icon free helper
    Close