Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
416 lines (366 sloc) 11.5 KB
/* omhiredis.c
* Copyright 2012 Talksum, Inc
* Copyright 2015 DigitalOcean, Inc
*
* This program is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program. If not, see
* <http://www.gnu.org/licenses/>.
*
* Author: Brian Knox
* <bknox@digitalocean.com>
*/
#include "config.h"
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <ctype.h>
#include <errno.h>
#include <assert.h>
#include <signal.h>
#include <time.h>
#include <hiredis/hiredis.h>
#include "rsyslog.h"
#include "conf.h"
#include "syslogd-types.h"
#include "srUtils.h"
#include "template.h"
#include "module-template.h"
#include "errmsg.h"
#include "cfsysline.h"
#include "unicode-helper.h"
MODULE_TYPE_OUTPUT
MODULE_TYPE_NOKEEP
MODULE_CNFNAME("omhiredis")
/* internal structures
*/
DEF_OMOD_STATIC_DATA
#define OMHIREDIS_MODE_TEMPLATE 0
#define OMHIREDIS_MODE_QUEUE 1
#define OMHIREDIS_MODE_PUBLISH 2
/* our instance data.
* this will be accessable
* via pData */
typedef struct _instanceData {
uchar *server; /* redis server address */
int port; /* redis port */
uchar *serverpassword; /* redis password */
uchar *tplName; /* template name */
char *modeDescription; /* mode description */
int mode; /* mode constant */
uchar *key; /* key for QUEUE and PUBLISH modes */
sbool dynaKey; /* Should we treat the key as a template? */
sbool useRPush; /* Should we use RPUSH instead of LPUSH? */
} instanceData;
typedef struct wrkrInstanceData {
instanceData *pData; /* instanc data */
redisContext *conn; /* redis connection */
int count; /* count of command sent for current batch */
} wrkrInstanceData_t;
static struct cnfparamdescr actpdescr[] = {
{ "server", eCmdHdlrGetWord, 0 },
{ "serverport", eCmdHdlrInt, 0 },
{ "serverpassword", eCmdHdlrGetWord, 0 },
{ "template", eCmdHdlrGetWord, 0 },
{ "mode", eCmdHdlrGetWord, 0 },
{ "key", eCmdHdlrGetWord, 0 },
{ "dynakey", eCmdHdlrBinary, 0 },
{ "userpush", eCmdHdlrBinary, 0 },
};
static struct cnfparamblk actpblk = {
CNFPARAMBLK_VERSION,
sizeof(actpdescr)/sizeof(struct cnfparamdescr),
actpdescr
};
BEGINcreateInstance
CODESTARTcreateInstance
ENDcreateInstance
BEGINcreateWrkrInstance
CODESTARTcreateWrkrInstance
pWrkrData->conn = NULL; /* Connect later */
ENDcreateWrkrInstance
BEGINisCompatibleWithFeature
CODESTARTisCompatibleWithFeature
if(eFeat == sFEATURERepeatedMsgReduction)
iRet = RS_RET_OK;
ENDisCompatibleWithFeature
/* called when closing */
static void closeHiredis(wrkrInstanceData_t *pWrkrData)
{
if(pWrkrData->conn != NULL) {
redisFree(pWrkrData->conn);
pWrkrData->conn = NULL;
}
}
/* Free our instance data. */
BEGINfreeInstance
CODESTARTfreeInstance
if (pData->server != NULL) {
free(pData->server);
}
ENDfreeInstance
BEGINfreeWrkrInstance
CODESTARTfreeWrkrInstance
closeHiredis(pWrkrData);
ENDfreeWrkrInstance
BEGINdbgPrintInstInfo
CODESTARTdbgPrintInstInfo
/* nothing special here */
ENDdbgPrintInstInfo
/* establish our connection to redis */
static rsRetVal initHiredis(wrkrInstanceData_t *pWrkrData, int bSilent)
{
char *server;
char *serverpasswd;
DEFiRet;
server = (pWrkrData->pData->server == NULL) ? (char *)"127.0.0.1" :
(char*) pWrkrData->pData->server;
DBGPRINTF("omhiredis: trying connect to '%s' at port %d\n", server,
pWrkrData->pData->port);
struct timeval timeout = { 1, 500000 }; /* 1.5 seconds */
pWrkrData->conn = redisConnectWithTimeout(server, pWrkrData->pData->port,
timeout);
if (pWrkrData->conn->err) {
if(!bSilent)
LogError(0, RS_RET_SUSPENDED,
"can not initialize redis handle");
ABORT_FINALIZE(RS_RET_SUSPENDED);
}
if (pWrkrData->pData->serverpassword != NULL) {
serverpasswd = (char*) pWrkrData->pData->serverpassword;
int rc;
rc = redisAppendCommand(pWrkrData->conn, "AUTH %s", serverpasswd);
if (rc == REDIS_ERR) {
LogError(0, NO_ERRCODE, "omhiredis: %s", pWrkrData->conn->errstr);
ABORT_FINALIZE(RS_RET_ERR);
} else {
pWrkrData->count++;
}
}
finalize_it:
RETiRet;
}
static rsRetVal writeHiredis(uchar* key, uchar *message, wrkrInstanceData_t *pWrkrData)
{
DEFiRet;
/* if we do not have a redis connection, call
* initHiredis and try to establish one */
if(pWrkrData->conn == NULL)
CHKiRet(initHiredis(pWrkrData, 0));
/* try to append the command to the pipeline.
* REDIS_ERR reply indicates something bad
* happened, in which case abort. otherwise
* increase our current pipeline count
* by 1 and continue. */
int rc;
switch(pWrkrData->pData->mode) {
case OMHIREDIS_MODE_TEMPLATE:
rc = redisAppendCommand(pWrkrData->conn, (char*)message);
break;
case OMHIREDIS_MODE_QUEUE:
rc = redisAppendCommand(pWrkrData->conn,
pWrkrData->pData->useRPush ? "RPUSH %s %s" : "LPUSH %s %s",
key, (char*)message);
break;
case OMHIREDIS_MODE_PUBLISH:
rc = redisAppendCommand(pWrkrData->conn, "PUBLISH %s %s", key, (char*)message);
break;
default:
dbgprintf("omhiredis: mode %d is invalid something is really wrong\n",
pWrkrData->pData->mode);
ABORT_FINALIZE(RS_RET_ERR);
}
if (rc == REDIS_ERR) {
LogError(0, NO_ERRCODE, "omhiredis: %s", pWrkrData->conn->errstr);
dbgprintf("omhiredis: %s\n", pWrkrData->conn->errstr);
ABORT_FINALIZE(RS_RET_ERR);
} else {
pWrkrData->count++;
}
finalize_it:
RETiRet;
}
/* called when resuming from suspended state.
* try to restablish our connection to redis */
BEGINtryResume
CODESTARTtryResume
if(pWrkrData->conn == NULL)
iRet = initHiredis(pWrkrData, 0);
ENDtryResume
/* begin a transaction.
* if I decide to use MULTI ... EXEC in the
* future, this block should send the
* MULTI command to redis. */
BEGINbeginTransaction
CODESTARTbeginTransaction
dbgprintf("omhiredis: beginTransaction called\n");
pWrkrData->count = 0;
ENDbeginTransaction
/* call writeHiredis for this log line,
* which appends it as a command to the
* current pipeline */
BEGINdoAction
CODESTARTdoAction
if(pWrkrData->pData->dynaKey) {
CHKiRet(writeHiredis(ppString[1], ppString[0], pWrkrData));
}
else {
CHKiRet(writeHiredis(pWrkrData->pData->key, ppString[0], pWrkrData));
}
iRet = RS_RET_DEFER_COMMIT;
finalize_it:
ENDdoAction
/* called when we have reached the end of a
* batch (queue.dequeuebatchsize). this
* iterates over the replies, putting them
* into the pData->replies buffer. we currently
* don't really bother to check for errors
* which should be fixed */
BEGINendTransaction
CODESTARTendTransaction
dbgprintf("omhiredis: endTransaction called\n");
redisReply *reply;
int i;
for ( i = 0; i < pWrkrData->count; i++ ) {
redisGetReply ( pWrkrData->conn, (void*)&reply);
if( pWrkrData->conn->err ){
dbgprintf("omhiredis: %s\n", pWrkrData->conn->errstr);
closeHiredis(pWrkrData);
ABORT_FINALIZE(RS_RET_SUSPENDED);
}
else {
freeReplyObject(reply);
}
}
finalize_it:
ENDendTransaction
/* set defaults. note server is set to NULL
* and is set to a default in initHiredis if
* it is still null when it's called - I should
* probable just set the default here instead */
static void
setInstParamDefaults(instanceData *pData)
{
pData->server = NULL;
pData->port = 6379;
pData->serverpassword = NULL;
pData->tplName = NULL;
pData->mode = OMHIREDIS_MODE_TEMPLATE;
pData->modeDescription = (char *)"template";
pData->key = NULL;
pData->useRPush = 0;
}
/* here is where the work to set up a new instance
* is done. this reads the config options from
* the rsyslog conf and takes appropriate setup
* actions. */
BEGINnewActInst
struct cnfparamvals *pvals;
int i;
int iNumTpls;
CODESTARTnewActInst
if((pvals = nvlstGetParams(lst, &actpblk, NULL)) == NULL)
ABORT_FINALIZE(RS_RET_MISSING_CNFPARAMS);
CHKiRet(createInstance(&pData));
setInstParamDefaults(pData);
for(i = 0 ; i < actpblk.nParams ; ++i) {
if(!pvals[i].bUsed)
continue;
if(!strcmp(actpblk.descr[i].name, "server")) {
pData->server = (uchar*)es_str2cstr(pvals[i].val.d.estr, NULL);
} else if(!strcmp(actpblk.descr[i].name, "serverport")) {
pData->port = (int) pvals[i].val.d.n;
} else if(!strcmp(actpblk.descr[i].name, "serverpassword")) {
pData->serverpassword = (uchar*)es_str2cstr(pvals[i].val.d.estr, NULL);
} else if(!strcmp(actpblk.descr[i].name, "template")) {
pData->tplName = (uchar*)es_str2cstr(pvals[i].val.d.estr, NULL);
} else if(!strcmp(actpblk.descr[i].name, "dynakey")) {
pData->dynaKey = pvals[i].val.d.n;
} else if(!strcmp(actpblk.descr[i].name, "userpush")) {
pData->useRPush = pvals[i].val.d.n;
} else if(!strcmp(actpblk.descr[i].name, "mode")) {
pData->modeDescription = es_str2cstr(pvals[i].val.d.estr, NULL);
if (!strcmp(pData->modeDescription, "template")) {
pData->mode = OMHIREDIS_MODE_TEMPLATE;
} else if (!strcmp(pData->modeDescription, "queue")) {
pData->mode = OMHIREDIS_MODE_QUEUE;
} else if (!strcmp(pData->modeDescription, "publish")) {
pData->mode = OMHIREDIS_MODE_PUBLISH;
} else {
dbgprintf("omhiredis: unsupported mode %s\n", actpblk.descr[i].name);
ABORT_FINALIZE(RS_RET_MISSING_CNFPARAMS);
}
} else if(!strcmp(actpblk.descr[i].name, "key")) {
pData->key = (uchar*)es_str2cstr(pvals[i].val.d.estr, NULL);
} else {
dbgprintf("omhiredis: program error, non-handled "
"param '%s'\n", actpblk.descr[i].name);
}
}
dbgprintf("omhiredis: checking config sanity\n");
/* check config sanity for selected mode */
switch(pData->mode) {
case OMHIREDIS_MODE_QUEUE:
case OMHIREDIS_MODE_PUBLISH:
if (pData->key == NULL) {
dbgprintf("omhiredis: mode %s requires a key\n", pData->modeDescription);
ABORT_FINALIZE(RS_RET_MISSING_CNFPARAMS);
}
if (pData->tplName == NULL) {
dbgprintf("omhiredis: using default RSYSLOG_ForwardFormat template\n");
CHKmalloc(pData->tplName = ustrdup("RSYSLOG_ForwardFormat"));
}
break;
case OMHIREDIS_MODE_TEMPLATE:
if (pData->tplName == NULL) {
dbgprintf("omhiredis: selected mode requires template\n");
ABORT_FINALIZE(RS_RET_MISSING_CNFPARAMS);
}
break;
}
iNumTpls = 1;
if (pData->dynaKey) {
iNumTpls = 2;
}
CODE_STD_STRING_REQUESTnewActInst(iNumTpls);
CHKiRet(OMSRsetEntry(*ppOMSR, 0, (uchar*)pData->tplName, OMSR_NO_RQD_TPL_OPTS));
if (pData->dynaKey) {
CHKiRet(OMSRsetEntry(*ppOMSR, 1, ustrdup(pData->key), OMSR_NO_RQD_TPL_OPTS));
}
CODE_STD_FINALIZERnewActInst
cnfparamvalsDestruct(pvals, &actpblk);
ENDnewActInst
NO_LEGACY_CONF_parseSelectorAct
BEGINmodExit
CODESTARTmodExit
ENDmodExit
/* register our plugin entry points
* with the rsyslog core engine */
BEGINqueryEtryPt
CODESTARTqueryEtryPt
CODEqueryEtryPt_STD_OMOD_QUERIES
CODEqueryEtryPt_STD_OMOD8_QUERIES
CODEqueryEtryPt_STD_CONF2_OMOD_QUERIES
CODEqueryEtryPt_TXIF_OMOD_QUERIES /* supports transaction interface */
ENDqueryEtryPt
/* note we do not support rsyslog v5 syntax */
BEGINmodInit()
CODESTARTmodInit
*ipIFVersProvided = CURR_MOD_IF_VERSION; /* only supports rsyslog 6 configs */
CODEmodInit_QueryRegCFSLineHdlr
INITChkCoreFeature(bCoreSupportsBatching, CORE_FEATURE_BATCHING);
if (!bCoreSupportsBatching) {
LogError(0, NO_ERRCODE, "omhiredis: rsyslog core does not support batching - abort");
ABORT_FINALIZE(RS_RET_ERR);
}
DBGPRINTF("omhiredis: module compiled with rsyslog version %s.\n", VERSION);
ENDmodInit