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日志并进行多维度分析。
目录
相关文章
|
17天前
|
存储 缓存 关系型数据库
图解MySQL【日志】——Redo Log
Redo Log(重做日志)是数据库中用于记录数据页修改的物理日志,确保事务的持久性和一致性。其主要作用包括崩溃恢复、提高性能和保证事务一致性。Redo Log 通过先写日志的方式,在内存中缓存修改操作,并在适当时候刷入磁盘,减少随机写入带来的性能损耗。WAL(Write-Ahead Logging)技术的核心思想是先将修改操作记录到日志文件中,再择机写入磁盘,从而实现高效且安全的数据持久化。Redo Log 的持久化过程涉及 Redo Log Buffer 和不同刷盘时机的控制参数(如 `innodb_flush_log_at_trx_commit`),以平衡性能与数据安全性。
27 5
图解MySQL【日志】——Redo Log
|
4月前
|
XML 安全 Java
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
本文介绍了Java日志框架的基本概念和使用方法,重点讨论了SLF4J、Log4j、Logback和Log4j2之间的关系及其性能对比。SLF4J作为一个日志抽象层,允许开发者使用统一的日志接口,而Log4j、Logback和Log4j2则是具体的日志实现框架。Log4j2在性能上优于Logback,推荐在新项目中使用。文章还详细说明了如何在Spring Boot项目中配置Log4j2和Logback,以及如何使用Lombok简化日志记录。最后,提供了一些日志配置的最佳实践,包括滚动日志、统一日志格式和提高日志性能的方法。
1147 31
【日志框架整合】Slf4j、Log4j、Log4j2、Logback配置模板
|
3月前
|
监控 安全 Apache
什么是Apache日志?为什么Apache日志分析很重要?
Apache是全球广泛使用的Web服务器软件,支持超过30%的活跃网站。它通过接收和处理HTTP请求,与后端服务器通信,返回响应并记录日志,确保网页请求的快速准确处理。Apache日志分为访问日志和错误日志,对提升用户体验、保障安全及优化性能至关重要。EventLog Analyzer等工具可有效管理和分析这些日志,增强Web服务的安全性和可靠性。
|
1月前
|
存储 SQL 关系型数据库
MySQL日志详解——日志分类、二进制日志bin log、回滚日志undo log、重做日志redo log
MySQL日志详解——日志分类、二进制日志bin log、回滚日志undo log、重做日志redo log、原理、写入过程;binlog与redolog区别、update语句的执行流程、两阶段提交、主从复制、三种日志的使用场景;查询日志、慢查询日志、错误日志等其他几类日志
105 35
MySQL日志详解——日志分类、二进制日志bin log、回滚日志undo log、重做日志redo log
|
5月前
|
XML JSON Java
Logback 与 log4j2 性能对比:谁才是日志框架的性能王者?
【10月更文挑战第5天】在Java开发中,日志框架是不可或缺的工具,它们帮助我们记录系统运行时的信息、警告和错误,对于开发人员来说至关重要。在众多日志框架中,Logback和log4j2以其卓越的性能和丰富的功能脱颖而出,成为开发者们的首选。本文将深入探讨Logback与log4j2在性能方面的对比,通过详细的分析和实例,帮助大家理解两者之间的性能差异,以便在实际项目中做出更明智的选择。
533 3
|
2月前
|
SQL 关系型数据库 MySQL
MySQL事务日志-Undo Log工作原理分析
事务的持久性是交由Redo Log来保证,原子性则是交由Undo Log来保证。如果事务中的SQL执行到一半出现错误,需要把前面已经执行过的SQL撤销以达到原子性的目的,这个过程也叫做"回滚",所以Undo Log也叫回滚日志。
118 7
MySQL事务日志-Undo Log工作原理分析
|
19天前
|
存储 关系型数据库 MySQL
图解MySQL【日志】——Undo Log
Undo Log(回滚日志)是 MySQL 中用于实现事务原子性和一致性的关键机制。在默认的自动提交模式下,MySQL 隐式开启事务,每条增删改语句都会记录到 Undo Log 中。其主要作用包括:
32 0
|
3月前
|
存储 监控 安全
什么是事件日志管理系统?事件日志管理系统有哪些用处?
事件日志管理系统是IT安全的重要工具,用于集中收集、分析和解释来自组织IT基础设施各组件的事件日志,如防火墙、路由器、交换机等,帮助提升网络安全、实现主动威胁检测和促进合规性。系统支持多种日志类型,包括Windows事件日志、Syslog日志和应用程序日志,通过实时监测、告警及可视化分析,为企业提供强大的安全保障。然而,实施过程中也面临数据量大、日志管理和分析复杂等挑战。EventLog Analyzer作为一款高效工具,不仅提供实时监测与告警、可视化分析和报告功能,还支持多种合规性报告,帮助企业克服挑战,提升网络安全水平。
131 2
|
5月前
|
存储 缓存 关系型数据库
MySQL事务日志-Redo Log工作原理分析
事务的隔离性和原子性分别通过锁和事务日志实现,而持久性则依赖于事务日志中的`Redo Log`。在MySQL中,`Redo Log`确保已提交事务的数据能持久保存,即使系统崩溃也能通过重做日志恢复数据。其工作原理是记录数据在内存中的更改,待事务提交时写入磁盘。此外,`Redo Log`采用简单的物理日志格式和高效的顺序IO,确保快速提交。通过不同的落盘策略,可在性能和安全性之间做出权衡。
1895 14
MySQL事务日志-Redo Log工作原理分析
|
4月前
|
存储 监控 安全
什么是日志管理,如何进行日志管理?
日志管理是对IT系统生成的日志数据进行收集、存储、分析和处理的实践,对维护系统健康、确保安全及获取运营智能至关重要。本文介绍了日志管理的基本概念、常见挑战、工具的主要功能及选择解决方案的方法,强调了定义管理目标、日志收集与分析、警报和报告、持续改进等关键步骤,以及如何应对数据量大、安全问题、警报疲劳等挑战,最终实现日志数据的有效管理和利用。
458 0