Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/giginet/ccfluentdlogger
Log collector for cocos2d-x
https://github.com/giginet/ccfluentdlogger
Last synced: about 2 months ago
JSON representation
Log collector for cocos2d-x
- Host: GitHub
- URL: https://github.com/giginet/ccfluentdlogger
- Owner: giginet
- License: mit
- Created: 2015-06-07T05:50:29.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-06-07T13:53:23.000Z (over 9 years ago)
- Last Synced: 2024-10-14T09:53:43.972Z (3 months ago)
- Language: C++
- Homepage:
- Size: 88 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CCFluentdLogger
This is the cocos2d-x plugin to allow sending logs to fluentd easily.
## Requirements
- cocos2d-x 3.0+
## Setup server
You must launch a fluentd endpoint on local or remote.
You can launch local fluentd server in the following way.
### Setup
```sh
$ git clone https://github.com:giginet/CCFluentdLogger.git
$ cd CCFluentdLogger/fluentd
```
### Launch
```sh
$ bundle install
$ bundle exec foreman start
```
Then fluentd runs on `http://127.0.0.1:8888`
## Implement log collecting logic in your Game
Import all h/cpp files under `CCFluentdLogger/` into your project.
And register configuration to the logger.
Typically, you should implement the following logic on `AppDelegate::applicationDidFinishLaunching`.
```cpp
#include "CCFluentdLogger.h"
using namespace ccFluentdLogger;
bool AppDelegate::applicationDidFinishLaunching() {
// Get shared logger instance
Logger * logger = Logger::getInstance();
// Get default logger settings
Configuration config = Logger::getDefaultConfiguration();
config.host = "http://127.0.0.1";
config.port = 8888;
// Set configuration
logger->setConfiguration(config);
}
```
Implement this snippets to post logs.
```cpp
#include "CCFluentdLogger.h"
using namespace ccFluentdLogger;
void onButtonPressed()
{
// Something to do
// Get shared logger instance
Logger * logger = Logger::getInstance();
// Post log
logger->postLog("action", json11::Json::object {{"key", "value"}});
}
```
These are all to do to post logs to the remote host.
## Buffering
On above way, Logs are sent sequentially.
This plugin also allows to store logs and post them on specific timings like the game is end.
To buffer the logs, you should execute `Logger::postLog` with third-argument, execute `Logger::postBuffered` to send all buffered logs.
```cpp
#include "CCFluentdLogger.h"
using namespace ccFluentdLogger;
void onButtonPressed()
{
// Something to do
// Get shared logger instance
Logger * logger = Logger::getInstance();
// Add log to buffer
// Third argument indicates whether to enable buffering or not
logger->postLog("action", json11::Json::object {{"key", "value"}}, true);
}
void onGameOver()
{
Logger * logger = Logger::getInstance();
// Post all buffered logs at one time.
logger->postBuffered();
}
```
You can set default `postLog` behavior with `Configuration.isBufferingEnabled`.
## Run sample project
1. Create a new project with `cocos` command.
2. Copy `newProj/cocos2d` to `sample/cocos2d`
3. open `CCFluentdLogger.xcodeproj`.
## Author
giginet
## License
MIT License