node-loggly 项目技术文档

1. 安装指南

安装 npm (Node Package Manager)

首先，确保你已经安装了 Node.js 和 npm。如果尚未安装，可以通过以下命令安装 npm：

$ curl http://npmjs.org/install.sh | sh

安装 node-loggly

使用 npm 安装 node-loggly 包：

$ npm install loggly

2. 项目的使用说明

创建 Loggly 客户端

在使用 node-loggly 之前，你需要创建一个带有有效凭证的客户端。以下是创建客户端的示例代码：

var loggly = require('loggly');

var client = loggly.createClient({
  token: "your-really-long-input-token",
  subdomain: "your-subdomain",
  auth: {
    username: "your-username",
    password: "your-password"
  },
  // 可选：发送每条日志消息时附加的标签
  tags: ['global-tag']
});

日志记录

你可以通过两种方式将日志信息发送到 Loggly。第一种方式是直接调用 client.log 方法，并传入一个输入令牌：

client.log('127.0.0.1 - Theres no place like home', function (err, result) {
  // 日志记录完成后执行的操作
});

如果不需要回调函数，可以使用“触发即忘”的方式：

client.log('127.0.0.1 - Theres no place like home');

使用标签记录日志

如果你使用 Loggly 的标签功能，可以在 log 方法的第二个参数中传入一个标签数组：

client.log('127.0.0.1 - Theres no place like home', [ 'dorothy' ], function (err, result) {
  // 日志记录完成后执行的操作
});

注意：传递给 log 方法的标签将与全局标签合并。

记录浅层 JSON 对象为字符串

除了记录纯字符串外，还可以传递浅层 JSON 对象（即没有嵌套对象）到 client.log 方法中，这些对象将被转换为 Loggly 推荐的字符串表示形式：

var source = {
  foo: 1,
  bar: 2,
  buzz: 3
};

client.log(source);

这将记录为：

foo=1,bar=2,buzz=3

记录 JSON 对象

你还可以使用 Loggly 的新 JSON 功能记录复杂对象。只需在配置中添加 json: true 即可启用 JSON 功能：

var config = {
  subdomain: "your-subdomain",
  auth: {
    username: "your-username",
    password: "your-password"
  },
  json: true
};

启用 JSON 标志后，对象将在传输到 Loggly 之前使用 JSON.stringify 转换为 JSON 格式：

var source = {
  foo: 1,
  bar: 2,
  buzz: {
    sheep: 'jumped',
    times: 10
  }
};

client.log(source);

这将记录为：

{ "foo": 1, "bar": 2, "buzz": {"sheep": "jumped", "times": 10 }}

记录数组

你可以发送数组，这将导致一次请求发送到 Loggly：

client.log([ {iam:'number 1'}, {iam:'number 2'} ]);

搜索日志

使用 node-loggly 进行搜索非常简单。只需在 Loggly 客户端上使用 search() 方法：

var util = require('util');

client.search('404', function (err, results) {
  // 检查结果集
  console.dir(results.events);
});

search() 方法还可以接受一个对象参数，允许你设置额外的搜索参数，如 rows、from、until 等：

var util = require('util');

client.search({ query: '404', rows: 10 })
  .run(function (err, results) {
    // 检查结果集
    console.dir(results.events);
  });

3. 项目API使用文档

创建客户端

• 方法: loggly.createClient(config)
• 参数:
  • config: 包含 token、subdomain、auth 等配置的对象。
• 返回值: Loggly 客户端实例。

记录日志

• 方法: client.log(message, [tags], [callback])
• 参数:
  • message: 要记录的消息或对象。
  • tags: 可选，标签数组。
  • callback: 可选，日志记录完成后的回调函数。

搜索日志

• 方法: client.search(query, [options], callback)
• 参数:
  • query: 搜索查询字符串。
  • options: 可选，包含额外搜索参数的对象。
  • callback: 搜索完成后的回调函数。

4. 项目安装方式

安装 npm

$ curl http://npmjs.org/install.sh | sh

安装 node-loggly

$ npm install loggly

通过以上步骤，你可以成功安装并使用 node-loggly 项目进行日志记录和搜索。