Magicodes.WeiChat——利用纷纭打造云日志频道

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 纷纭,是个免费的渠道集成工具。这里我就不多介绍了,右侧是飞机票:https://lesschat.com/ 在开发或者在运维情况下,我们经常需要查看并关注服务器端日志以确保程序是否健康运行。尤其是在微信开发过程中,我们经常要查看微信参数是否正确,而微信浏览器并不易于调测,故能够即时看到调测日志对我们来说相当重要,并且能够极大的提高开发效率。

纷纭,是个免费的渠道集成工具。这里我就不多介绍了,右侧是飞机票:https://lesschat.com/

在开发或者在运维情况下,我们经常需要查看并关注服务器端日志以确保程序是否健康运行。尤其是在微信开发过程中,我们经常要查看微信参数是否正确,而微信浏览器并不易于调测,故能够即时看到调测日志对我们来说相当重要,并且能够极大的提高开发效率。

而查看日志,我们还需要找到最近的日志文件查看最新日志,过程繁琐且不友好,并且需要自己主动去查看,没法关注重要信息。于是有了将日志信息推送到纷纭的想法,以实现日志渠道集成。

我们先来看看集成后的效果:

image

接下来,我来逐步介绍如何集成纷纭,并且将日志信息推送到其日志频道。

添加日志频道

第一步,我们需要在纷纭增加一个频道用于展示我们的日志信息。这一步我就不多介绍了,打开右侧链接:https://lesschat.com/,然后自己创建自己的日子频道吧。

添加服务集成

纷纭的强大与易用之处在于其服务集成。目前貌似已经支持100+服务了,比如Worktile、github、麦客、邮箱等等服务,如:

image

image

服务虽多,但是这里我们只需要用到Incoming WebHook,如下所示:

image

当你添加该服务,纷纭就会给你提供一个WebHook地址,如下所示:

image

 

纷纭对消息展示上支持很多设置,如下所示:

image

纷纭设置好了,接下来就开启编码了。

配置NLog

为了不修改现有代码,我们使用成熟的日志——NLog进行处理。对于网站,我们不需要编写任何代码,我们只需要在NLog的配置文件增加如下配置:

<!--日志频道 纷云-->
    <target type="WebService"
            name="wsLog"
            url="http://magicodes-weichat-log.chinacloudsites.cn/api/log"
            protocol="HttpPost"
            encoding="UTF-8"   >
      <!--参数必须 疑为NLog的Bug-->
      <parameter name="Start" type="System.String" layout="${level}"/>
      <!--安全密钥-->
      <parameter name="Key" type="System.String" layout="请设置自己的密钥"/>
      <!--日志Level:必须-->
      <parameter name="Level" type="System.String" layout="${level}"/>
      <!--消息标题:必须,不支持特殊字符-->
      <parameter name="Title" type="System.String" layout="【Magicodes.WeiChat】${message}"/>
      <!--详细内容-->
      <parameter name="Message" type="System.String" layout="---------------------------------------${logger}    ${time} --------------------------------${newline}${onexception:inner=${newline}${exception:format=tostring}}"/>

NLOG支持请求HTTP请求,这样我们只有在自己的配置文件中增加如上配置。然后设置日志级别即可,比如:

<logger name="*" minlevel="Trace" writeTo="wsLog" />

从上诉代码中,我们需要注意以下几点:

  • 请求地址为:http://magicodes-weichat-log.chinacloudsites.cn/api/log,这里不是直接指向纷纭,接下来我会贴上这个webApi的代码
  • 只需配置NLog.config中的配置即可,无需添加任何代码
  • 在rules配置中,我们将最低级别设置为Trace,即记录所有日志
  • 为了防止他人使用,这里进行了安全限制,即要求设置密钥

 

编写日志处理代码

在刚才的代码中,我们可以看到,http://magicodes-weichat-log.chinacloudsites.cn/api/log为自定义的日志处理程序。这个程序做了以下操作:

  • 接收日志信息
  • 验证密钥以及日志信息的正确性
  • 将调用lesschat日志频道Incoming WebHook地址,进行日志推送,并返回结果

整个代码并不复杂,全部代码如下所示:

using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Threading.Tasks;
using System.Web;
using System.Web.Http;

namespace LessChat.Log.Controllers
{
    public class LogController : ApiController
    {
        /// <summary>
        /// 日志数据模型
        /// </summary>
        public class LogInfo
        {
            /// <summary>
            /// 安全密钥
            /// </summary>
            [Required]
            public string Key { get; set; }
            /// <summary>
            /// 日志级别
            /// </summary>
            [Required]
            public string Level { get; set; }
            /// <summary>
            /// 标题
            /// </summary>
            [Required]
            public string Title { get; set; }
            /// <summary>
            /// 消息
            /// </summary>
            public string Message { get; set; }
        }
        /// <summary>
        /// 纷云传入接口模型
        /// </summary>
        public class LessChatIncomingInfo
        {
            public attachment attachment { get; set; }
        }
        public class attachment
        {
            /// <summary>
            /// 普通文本消息,支持\n换行
            /// </summary>

            public string text { get; set; }
            public string title { get; set; }
            public string title_link { get; set; }
            /// <summary>
            /// 在显示消息正文之前显示的文本内容
            /// </summary>
            public string pretext { get; set; }
            /// <summary>
            /// 将消息的正文用指定的颜色进行标示
            /// </summary>
            public string color { get; set; }
            /// <summary>
            /// 用于移动端将提示信息显示在首页上
            /// </summary>
            public string fallback { get; set; }
            /// <summary>
            /// 用于显示作者名
            /// </summary>
            public string author_name { get; set; }
            /// <summary>
            /// 作者主页超链接
            /// </summary>
            public string author_link { get; set; }
            /// <summary>
            /// 作者
            /// </summary>
            public string author_icon { get; set; }
            public List<field> fields { get; set; }
        }
        public class field
        {
            /// <summary>
            /// 分区消息标题
            /// </summary>
            public string title { get; set; }
            /// <summary>
            /// 分区消息内容
            /// </summary>
            public string value { get; set; }
            /// <summary>
            /// 1:标识消息的内容时候时候为短消息
            /// </summary>
            [JsonProperty(PropertyName = "short")]
            public string shortInfo { get; set; }
        }
        /// <summary>
        /// 密钥
        /// </summary>
        static string key = System.Web.Configuration.WebConfigurationManager.AppSettings["hoot.key"];
        /// <summary>
        /// Post
        /// </summary>
        public async Task<IHttpActionResult> Post([FromBody]LogInfo loginfo)
        {
            if (!ModelState.IsValid)
            {
                return BadRequest(ModelState);
            }
            //检查安全密钥
            if (!key.Equals(loginfo.Key, StringComparison.CurrentCultureIgnoreCase))
            {
                return BadRequest("安全密钥不匹配,请检查安全密钥!");
            }
            #region 设置颜色
            var color = "#FFFF33";
            switch (loginfo.Level)
            {
                case "Error":
                    color = "#FF3030";
                    break;
                case "Warn":
                    color = "#FFC125";
                    break;
                case "Debug":
                    color = "#FAEBD7";
                    break;
                case "Info":
                    color = "#FCFCFC";
                    break;
                case "Trace":
                    color = "#3CB371";
                    break;
                default:
                    break;
            }
            #endregion
            var data = new LessChatIncomingInfo()
            {
                attachment = new attachment()
                {
                    title = HttpUtility.UrlDecode(loginfo.Title),
                    text = HttpUtility.UrlDecode(loginfo.Message),
                    pretext = loginfo.Level,
                    color = color,
                    fallback = loginfo.Title
                }
            };
            return Ok(Log(data));
        }
        /// <summary>
        /// lesschat日志频道Incoming WebHook地址
        /// </summary>
        static string url = System.Web.Configuration.WebConfigurationManager.AppSettings["hoot.lesschat"];
        private static string Log(LessChatIncomingInfo data)
        {
            string json = JsonConvert.SerializeObject(data);
            var bytesToPost = System.Text.UTF8Encoding.UTF8.GetBytes(json);
            var wc = new WebClient();
            //Content-Type设置为application/json
            wc.Headers.Add("Content-Type", "application/json");
            var responseBytes = wc.UploadData(url, "POST", bytesToPost);
            var responseText = System.Text.UTF8Encoding.UTF8.GetString(responseBytes);
            return responseText;
        }
    }
}

上述代码相对比较简单,但是我们需要注意以下几个参数:

  • hoot.key:安全密钥,建议自己生成一个GUID放里面。
  • hoot.lesschat:lesschat日志频道Incoming WebHook地址

我们需要在Web.config配置上述参数,如:

image

 

尾声

至此,整个日志机制就打通了,我们可以方便的将应用程序日志推送到纷纭的日志频道,然后用Web、PC、手机端来查看日志,妈妈再也不用担心我们遗漏重要的错误日志了,同时,我们还可以对日志进行整理,比如只关心错误日志或者更严重级别的日志

最后,再补充一点。LogController可以集成在应用程序中,也可以部署为单独的站点来提供WebAPI服务,这里建议将其部署为单独的站点,以方便多个应用程序调用。

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
|
21天前
|
XML JSON Java
Logback 与 log4j2 性能对比:谁才是日志框架的性能王者?
【10月更文挑战第5天】在Java开发中,日志框架是不可或缺的工具,它们帮助我们记录系统运行时的信息、警告和错误,对于开发人员来说至关重要。在众多日志框架中,Logback和log4j2以其卓越的性能和丰富的功能脱颖而出,成为开发者们的首选。本文将深入探讨Logback与log4j2在性能方面的对比,通过详细的分析和实例,帮助大家理解两者之间的性能差异,以便在实际项目中做出更明智的选择。
135 3
|
3月前
|
Kubernetes Ubuntu Windows
【Azure K8S | AKS】分享从AKS集群的Node中查看日志的方法(/var/log)
【Azure K8S | AKS】分享从AKS集群的Node中查看日志的方法(/var/log)
118 3
|
21天前
|
存储 缓存 关系型数据库
MySQL事务日志-Redo Log工作原理分析
事务的隔离性和原子性分别通过锁和事务日志实现,而持久性则依赖于事务日志中的`Redo Log`。在MySQL中,`Redo Log`确保已提交事务的数据能持久保存,即使系统崩溃也能通过重做日志恢复数据。其工作原理是记录数据在内存中的更改,待事务提交时写入磁盘。此外,`Redo Log`采用简单的物理日志格式和高效的顺序IO,确保快速提交。通过不同的落盘策略,可在性能和安全性之间做出权衡。
1585 14
|
17天前
|
Python
log日志学习
【10月更文挑战第9天】 python处理log打印模块log的使用和介绍
20 0
|
18天前
|
数据可视化
Tensorboard可视化学习笔记(一):如何可视化通过网页查看log日志
关于如何使用TensorBoard进行数据可视化的教程,包括TensorBoard的安装、配置环境变量、将数据写入TensorBoard、启动TensorBoard以及如何通过网页查看日志文件。
92 0
|
21天前
|
存储 分布式计算 NoSQL
大数据-136 - ClickHouse 集群 表引擎详解1 - 日志、Log、Memory、Merge
大数据-136 - ClickHouse 集群 表引擎详解1 - 日志、Log、Memory、Merge
24 0
|
22天前
|
缓存 Linux 编译器
【C++】CentOS环境搭建-安装log4cplus日志组件包及报错解决方案
通过上述步骤,您应该能够在CentOS环境中成功安装并使用log4cplus日志组件。面对任何安装或使用过程中出现的问题,仔细检查错误信息,对照提供的解决方案进行调整,通常都能找到合适的解决之道。log4cplus的强大功能将为您的项目提供灵活、高效的日志管理方案,助力软件开发与维护。
43 0
|
2月前
|
Java
日志框架log4j打印异常堆栈信息携带traceId,方便接口异常排查
日常项目运行日志,异常栈打印是不带traceId,导致排查问题查找异常栈很麻烦。
|
2月前
|
存储 监控 数据可视化
SLS 虽然不是直接使用 OSS 作为底层存储,但它凭借自身独特的存储架构和功能,为用户提供了一种专业、高效的日志服务解决方案。
【9月更文挑战第2天】SLS 虽然不是直接使用 OSS 作为底层存储,但它凭借自身独特的存储架构和功能,为用户提供了一种专业、高效的日志服务解决方案。
123 9
|
3月前
|
开发框架 .NET Docker
【Azure 应用服务】App Service .NET Core项目在Program.cs中自定义添加的logger.LogInformation,部署到App Service上后日志不显示Log Stream中的问题
【Azure 应用服务】App Service .NET Core项目在Program.cs中自定义添加的logger.LogInformation,部署到App Service上后日志不显示Log Stream中的问题