content
large_stringlengths
3
20.5k
url
large_stringlengths
53
192
branch
large_stringclasses
4 values
source
large_stringclasses
51 values
embeddings
listlengths
384
384
score
float64
-0.21
0.65
of RedisModuleString. \* `!` -- Sends the Redis command and its arguments to replicas and AOF. \* `A` -- Suppress AOF propagation, send only to replicas (requires `!`). \* `R` -- Suppress replicas propagation, send only to AOF (requires `!`). \* `3` -- Return a RESP3 reply. This will change the command reply. e.g., HGE...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.00872464757412672, -0.016067994758486748, -0.1349550485610962, 0.03041156753897667, -0.010190986096858978, -0.07431980967521667, 0.12534193694591522, 0.010160171426832676, -0.00114659802056849, -0.021394941955804825, -0.016236193478107452, -0.07256767898797989, 0.05734853446483612, -0.0...
0.165368
a replica) or relying on the disconnect callback of the original client. Failing to do so can result in a write operation on a replica. Unlike other call replies, promise call reply \*\*must\*\* be freed while the Redis GIL is locked. Notice that on unblocking, the only promise is that the unblock handler will be calle...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.15078270435333252, -0.04912767559289932, -0.0647500678896904, 0.057031016796827316, 0.020491013303399086, -0.07216809689998627, 0.010556263849139214, -0.05289691314101219, 0.0782996416091919, 0.010802463628351688, -0.004140907432883978, 0.06418660283088684, 0.000439409603131935, -0.0457...
0.12743
For example the module "tree-AntZ" initially used encver=0. Later after an upgrade, it started to serialize data in a different format and to register the type with encver=1. However this module may still load old data produced by an older version if the `rdb\_load` callback is able to check the encver value and act ac...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.0037966438103467226, -0.01431945338845253, -0.04793979600071907, 0.013801857829093933, -0.010238257236778736, -0.03704584389925003, -0.05127539485692978, 0.027862509712576866, -0.1014656126499176, 0.02456985041499138, 0.01804923824965954, -0.008743200451135635, -0.0006798068061470985, -...
0.034549
time limit, so [`RedisModule\_DefragShouldStop()`](#RedisModule\_DefragShouldStop) always returns zero. The "late defrag" mechanism which has a time limit and provides cursor support is used only for keys that are determined to have significant internal complexity. To determine this, the defrag mechanism uses the `free...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.03135963901877403, -0.00042594721890054643, -0.0817505270242691, 0.007452947553247213, 0.038965001702308655, -0.10682496428489685, 0.11374218016862869, 0.09947207570075989, -0.044633012264966965, 0.006520635448396206, 0.012767894193530083, 0.029422327876091003, 0.03828190267086029, -0.0...
0.157878
unsigned 64 bit value into the RDB file. This function should only be called in the context of the `rdb\_save` method of modules implementing new data types. ### `RedisModule\_LoadUnsigned` uint64\_t RedisModule\_LoadUnsigned(RedisModuleIO \*io); \*\*Available since:\*\* 4.0.0 Load an unsigned 64 bit value from the RDB...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ 0.07578077912330627, 0.030161675065755844, -0.09278734773397446, -0.017173029482364655, -0.054925233125686646, 0.009052298963069916, -0.025362027809023857, 0.06452581286430359, -0.09309985488653183, 0.017204612493515015, -0.01166684553027153, -0.05592711642384529, 0.06499528139829636, -0.0...
0.013711
type, loads back the long double value saved by [`RedisModule\_SaveLongDouble()`](#RedisModule\_SaveLongDouble). ## Key digest API (DEBUG DIGEST interface for modules types) ### `RedisModule\_DigestAddStringBuffer` void RedisModule\_DigestAddStringBuffer(RedisModuleDigest \*md, const char \*ele, size\_t len); \*\*Avail...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ 0.04663857817649841, -0.02519715391099453, -0.058461640030145645, 0.04401180148124695, -0.05980667471885681, -0.06702651083469391, 0.0527845099568367, -0.004539534915238619, -0.02482474222779274, -0.050056472420692444, 0.004422045778483152, 0.0013273553922772408, 0.02586827427148819, -0.07...
0.115398
the AOF rewriting process. This function is only called in the context of the `aof\_rewrite` method of data types exported by a module. The command works exactly like [`RedisModule\_Call()`](#RedisModule\_Call) in the way the parameters are passed, but it does not return anything as the error handling is performed by R...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.015575017780065536, 0.0009795152582228184, -0.04206237941980362, 0.060422301292419434, -0.027926597744226456, -0.0845203846693039, 0.0733356699347496, 0.042740099132061005, -0.007599682547152042, 0.015750929713249207, -0.02636522799730301, -0.014723378233611584, -0.020718954503536224, -...
0.126771
following actions: (1) Authenticate - Use the `RedisModule\_AuthenticateClient`\* API and return `REDISMODULE\_AUTH\_HANDLED`. This will immediately end the auth chain as successful and add the OK reply. (2) Deny Authentication - Return `REDISMODULE\_AUTH\_HANDLED` without authenticating or blocking the client. Optiona...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.12268833070993423, 0.07464609295129776, -0.04848455637693405, 0.04765790328383446, 0.02091224491596222, -0.08439906686544418, 0.0384947694838047, -0.03109772875905037, 0.020026126876473427, -0.02566942758858204, -0.005333370994776487, -0.027311047539114952, 0.07017084956169128, 0.028462...
0.052929
zero value. Measuring background time: By default the time spent in the blocked command is not account for the total command duration. To include such time you should use [`RedisModule\_BlockedClientMeasureTimeStart()`](#RedisModule\_BlockedClientMeasureTimeStart) and [`RedisModule\_BlockedClientMeasureTimeEnd()`](#Red...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.06131891533732414, 0.051514096558094025, -0.08203888684511185, 0.027187997475266457, 0.042033787816762924, -0.07045034319162369, 0.02371237985789776, -0.0014022282557561994, 0.05167732015252113, -0.03419274464249611, -0.002383577637374401, -0.1082196980714798, 0.015026313252747059, 0.01...
0.056075
unblocking is performed by Redis itself, so we need to have some private data before hand. The private data is used to store any information about the specific unblocking operation that you are implementing. Such information will be freed using the `free\_privdata` callback provided by the user. However the reply callb...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.09703602641820908, 0.0010198048548772931, -0.10299833863973618, 0.048882436007261276, -0.008147330023348331, -0.022960079833865166, 0.006282041314989328, -0.0225497018545866, 0.03733719885349274, -0.01399286463856697, 0.007258704863488674, 0.022272730246186256, -0.007372533902525902, -0...
0.024278
is called. ### `RedisModule\_IsBlockedReplyRequest` int RedisModule\_IsBlockedReplyRequest(RedisModuleCtx \*ctx); \*\*Available since:\*\* 4.0.0 Return non-zero if a module command was called in order to fill the reply for a blocked client. ### `RedisModule\_IsBlockedTimeoutRequest` int RedisModule\_IsBlockedTimeoutReq...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.022057093679904938, 0.038112834095954895, -0.09719625115394592, 0.030219074338674545, 0.00528284115716815, -0.01289067417383194, 0.05685081705451012, 0.019717738032341003, -0.025039659813046455, -0.012011957354843616, 0.05260052531957626, -0.06378232687711716, 0.01135907880961895, -0.03...
0.119413
their type (string events, set events, etc), and the subscriber callback receives only events that match a specific mask of event types. When subscribing to notifications with [`RedisModule\_SubscribeToKeyspaceEvents`](#RedisModule\_SubscribeToKeyspaceEvents) the module must provide an event type-mask, denoting the eve...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.016844013705849648, -0.03527521714568138, 0.0017430963926017284, 0.06400282680988312, 0.060816001147031784, -0.02410362847149372, 0.11986593157052994, -0.030429990962147713, 0.038859207183122635, -0.05088881775736809, -0.009029067121446133, -0.08931252360343933, 0.02106044627726078, 0.0...
0.128378
of the feature correctness and so Redis will make no attempt to protect the module from infinite loops. '`free\_pd`' can be NULL and in such case will not be used. Return `REDISMODULE\_OK` on success and `REDISMODULE\_ERR` if was called while loading data from disk (AOF or RDB) or if the instance is a readonly replica....
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.02542608045041561, -0.023577604442834854, -0.06481867283582687, 0.00044364601490087807, 0.05583985522389412, -0.05060616880655289, 0.08022931963205338, 0.011630917899310589, 0.004942173603922129, -0.024225883185863495, 0.04610748961567879, -0.06309220939874649, 0.041985884308815, -0.085...
0.104584
(only populated if the instance is a slave) are specified, they point to buffers holding at least `REDISMODULE\_NODE\_ID\_LEN` bytes. The strings written back as `ip` and `master\_id` are not null terminated. The list of flags reported is the following: \* `REDISMODULE\_NODE\_MYSELF`: This node \* `REDISMODULE\_NODE\_M...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ 0.00875362940132618, 0.0014705476351082325, -0.06908532232046127, 0.04716144874691963, 0.049776166677474976, -0.03373843804001808, 0.009727943688631058, -0.02275325544178486, -0.05829562619328499, -0.00005776532634627074, -0.005505644250661135, -0.03397219628095627, 0.02500511333346367, -0...
0.152042
time before firing (in milliseconds), and the private data pointer associated with the timer. If the timer specified does not exist or belongs to a different module no information is returned and the function returns `REDISMODULE\_ERR`, otherwise `REDISMODULE\_OK` is returned. The arguments remaining or data can be NUL...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ 0.029055438935756683, 0.03110956959426403, -0.10006647557020187, 0.07721124589443207, -0.02953682839870453, -0.03548622503876686, 0.0872969999909401, 0.0621199756860733, 0.03383639454841614, -0.03031543456017971, 0.03039821796119213, -0.10263124853372574, -0.050118595361709595, -0.01387740...
0.168437
Returns `REDISMODULE\_OK` on success and `REDISMODULE\_ERR` on failure and will set an errno describing why the operation failed. ### `RedisModule\_SetModuleUserACLString` int RedisModule\_SetModuleUserACLString(RedisModuleCtx \*ctx, RedisModuleUser \*user, const char \*acl, RedisModuleString \*\*error); \*\*Available ...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.03887438029050827, 0.02242635190486908, -0.08319592475891113, 0.06153689697384834, -0.04054996743798256, -0.065894216299057, 0.12610043585300446, 0.06052428111433983, -0.043775979429483414, -0.07874183356761932, 0.031036537140607834, -0.064351387321949, 0.051052071154117584, 0.016482142...
0.110517
is able to access the pubsub channel then `REDISMODULE\_OK` is returned, otherwise `REDISMODULE\_ERR` is returned and errno is set to one of the following values: \* EINVAL: The provided flags are invalid. \* EACCESS: The user does not have permission to access the pubsub channel. ### `RedisModule\_ACLAddLogEntry` int ...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ 0.02535814419388771, -0.025457898154854774, -0.1604013442993164, 0.017701270058751106, -0.007261462509632111, -0.04490678757429123, 0.05226610228419304, 0.0014363458612933755, 0.007637823466211557, -0.04035180062055588, 0.010301589965820312, -0.05311179533600807, 0.024612100794911385, 0.01...
0.108596
\*\*Available since:\*\* 5.0.0 Create a new dictionary. The 'ctx' pointer can be the current module context or NULL, depending on what you want. Please follow the following rules: 1. Use a NULL context if you plan to retain a reference to this dictionary that will survive the time of the module callback where you creat...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.05028184875845909, 0.005881933029741049, -0.1026100292801857, 0.03846372291445732, -0.06436727941036224, -0.005561484955251217, 0.0747322142124176, 0.021343909204006195, -0.015759265050292015, -0.008788038045167923, 0.05308106169104576, 0.0003943542542401701, 0.021426180377602577, -0.00...
0.059704
by applying the operator 'op', which is just a string specifying the comparison operator to use in order to seek the first element. The operators available are: \* `^` – Seek the first (lexicographically smaller) key. \* `$` – Seek the last (lexicographically bigger) key. \* `>` – Seek the first element greater than th...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.0354275144636631, 0.04622366279363632, 0.016161054372787476, 0.00959479995071888, -0.07603183388710022, -0.11753963679075241, 0.0762333944439888, 0.008489061146974564, -0.041692450642585754, -0.037768326699733734, 0.026002265512943268, 0.019031409174203873, 0.07498025894165039, -0.03467...
0.080863
iterator, it selects the previous element (lexicographically smaller) instead of the next one. ### `RedisModule\_DictNext` RedisModuleString \*RedisModule\_DictNext(RedisModuleCtx \*ctx, RedisModuleDictIter \*di, void \*\*dataptr); \*\*Available since:\*\* 5.0.0 Like `RedisModuleNextC()`, but instead of returning an in...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ 0.012906729243695736, 0.012198731303215027, -0.021091749891638756, 0.04341442137956619, -0.07884340733289719, -0.0781640037894249, 0.09700775891542435, 0.0460239052772522, -0.016289634630084038, -0.05319648236036301, 0.04174825921654701, -0.041069287806749344, 0.0044124796986579895, -0.042...
0.084982
fields. When done, it needs to be freed with [`RedisModule\_FreeServerInfo`](#RedisModule\_FreeServerInfo) or with the automatic memory management mechanism if enabled. ### `RedisModule\_FreeServerInfo` void RedisModule\_FreeServerInfo(RedisModuleCtx \*ctx, RedisModuleServerInfoData \*data); \*\*Available since:\*\* 6....
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ 0.012725570239126682, -0.0000070303212851285934, -0.11429480463266373, 0.02613813243806362, -0.030021876096725464, -0.04510759562253952, 0.11710573732852936, 0.02420749142765999, -0.02915746532380581, -0.003310284810140729, 0.04470350965857506, -0.045922815799713135, 0.010555691085755825, ...
0.071499
requested API is not available then NULL is returned. Because modules can be loaded at different times with different order, this function calls should be put inside some module generic API registering step, that is called every time a module attempts to execute a command that requires external APIs: if some API cannot...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.07241848111152649, -0.03325691074132919, -0.04594182223081589, 0.04042380675673485, -0.05204033851623535, 0.0019528224365785718, -0.012975974939763546, 0.10119014233350754, -0.030874211341142654, -0.08308830857276917, 0.008708986453711987, -0.12702523171901703, 0.0010708689223974943, -0...
0.08545
include the command itself. ### `RedisModule\_CommandFilterArgGet` RedisModuleString \*RedisModule\_CommandFilterArgGet(RedisModuleCommandFilterCtx \*fctx, int pos); \*\*Available since:\*\* 5.0.5 Return the specified command argument. The first argument (position 0) is the command itself, and the rest are user-provide...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.006037721876055002, 0.0007239804835990071, -0.06988052278757095, 0.03146524727344513, -0.013807497918605804, -0.018364164978265762, 0.14542555809020996, 0.01810617186129093, -0.04303888976573944, -0.016970587894320488, -0.013691502623260021, -0.09615884721279144, -0.010914765298366547, ...
0.110812
be free when the callback returns. - `privdata`: the user data provided to [`RedisModule\_Scan()`](#RedisModule\_Scan). The way it should be used: RedisModuleScanCursor \*c = RedisModule\_ScanCursorCreate(); while(RedisModule\_Scan(ctx, c, callback, privateData)); RedisModule\_ScanCursorDestroy(c); It is also possible ...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.06933820247650146, -0.008233868516981602, -0.14497756958007812, -0.02343646250665188, -0.04705924540758133, -0.04086867719888687, 0.13126562535762787, -0.036098890006542206, -0.010600196197628975, -0.012351217679679394, 0.02660864032804966, 0.024140968918800354, 0.040811385959386826, -0...
0.101397
In general deleting the current element of the data structure is safe, while removing the key you are iterating is not safe. ## Module fork API ### `RedisModule\_Fork` int RedisModule\_Fork(RedisModuleForkDoneHandler cb, void \*user\_data); \*\*Available since:\*\* 6.0.0 Create a background child process with the curre...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.029751446098089218, 0.01565447449684143, -0.07042133063077927, -0.02427072450518608, -0.001228551845997572, -0.11635163426399231, 0.05816872417926788, 0.033971499651670456, 0.007620999589562416, 0.024543212726712227, 0.04795454815030098, 0.04996016249060631, 0.03732529655098915, -0.0668...
0.072502
be casted by the callback to a `RedisModuleReplicationInfo` structure with the following fields: int master; // true if master, false if replica char \*masterhost; // master instance hostname for NOW\_REPLICA int masterport; // master instance port for NOW\_REPLICA char \*replid1; // Main replication ID char \*replid2;...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.055690474808216095, -0.06454567611217499, -0.034626856446266174, -0.009712424129247665, -0.01784515753388405, -0.0034182274248450994, -0.005261996760964394, -0.04205511137843132, 0.043529026210308075, 0.017877984791994095, 0.03688749298453331, -0.02511594444513321, 0.0380840040743351, -...
0.12377
calls this function 10 times per second, but this changes depending on the "hz" configuration. No sub events are available. The data pointer can be casted to a RedisModuleCronLoop structure with the following fields: int32\_t hz; // Approximate number of events per second. \* `RedisModuleEvent\_MasterLinkChange` This i...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.06399377435445786, -0.07069522887468338, -0.05064723640680313, 0.0754009336233139, -0.02719518169760704, -0.028344061225652695, 0.02501819096505642, 0.007709567900747061, 0.038338448852300644, -0.021577240899205208, 0.026495615020394325, 0.024175403639674187, 0.01747838966548443, -0.044...
0.202887
config\_names array \* `RedisModule\_Event\_Key` Called when a key is removed from the keyspace. We can't modify any key in the event. The following sub events are available: \* `REDISMODULE\_SUBEVENT\_KEY\_DELETED` \* `REDISMODULE\_SUBEVENT\_KEY\_EXPIRED` \* `REDISMODULE\_SUBEVENT\_KEY\_EVICTED` \* `REDISMODULE\_SUBEV...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.03928197920322418, -0.017716873437166214, -0.04681308567523956, 0.05123474448919296, -0.0013342672027647495, -0.05894404649734497, 0.07676107436418533, -0.01226812694221735, 0.03623778000473976, -0.037565749138593674, 0.03710563853383064, 0.019624732434749603, 0.05195505917072296, -0.04...
0.145397
while the server is loading data. \* `REDISMODULE\_CONFIG\_MEMORY`: For numeric configs, this config will convert data unit notations into their byte equivalent. \* `REDISMODULE\_CONFIG\_BITFLAGS`: For enum configs, this config will allow multiple entries to be combined as bit flags. Default values are used on startup ...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ 0.03656916320323944, 0.014162356965243816, -0.16433241963386536, 0.032835595309734344, -0.09940876811742783, -0.02661040797829628, 0.09595142304897308, 0.08355402946472168, -0.06790594011545181, -0.0751912072300911, 0.03002176061272621, -0.009668576531112194, 0.030825922265648842, -0.08614...
0.163794
configs. ### `RedisModule\_LoadConfigs` int RedisModule\_LoadConfigs(RedisModuleCtx \*ctx); \*\*Available since:\*\* 7.0.0 Applies all pending configurations on the module load. This should be called after all of the configurations have been registered for the module inside of `RedisModule\_OnLoad`. This will return `R...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ 0.006591970566660166, -0.03563418239355087, -0.10663575679063797, 0.02514149621129036, -0.006938476115465164, 0.006854237988591194, 0.02794370800256729, 0.09899624437093735, -0.09924372285604477, -0.0063704680651426315, -0.030767710879445076, -0.00874012615531683, 0.00648169219493866, 0.02...
0.053167
check if a certain set of flags are supported by the redis server version in use. Example: int supportedFlags = RedisModule\_GetKeyspaceNotificationFlagsAll(); if (supportedFlags & REDISMODULE\_NOTIFY\_LOADED) { // REDISMODULE\_NOTIFY\_LOADED is supported } else{ // REDISMODULE\_NOTIFY\_LOADED is not supported } ### `R...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ 0.03263130038976669, -0.04561399295926094, -0.10499737411737442, -0.011467759497463703, 0.04981116205453873, -0.03837191313505173, 0.004201340023428202, -0.01097459252923727, -0.017660077661275864, -0.02090127393603325, -0.009129871614277363, -0.013019499368965626, -0.026905791833996773, -...
0.096471
\*ctx, unsigned long cursor); \*\*Available since:\*\* 6.2.0 Store an arbitrary cursor value for future re-use. This should only be called if [`RedisModule\_DefragShouldStop()`](#RedisModule\_DefragShouldStop) has returned a non-zero value and the defrag callback is about to exit without fully iterating its data type. ...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.11256297677755356, 0.01726105622947216, -0.057577282190322876, 0.026258936151862144, 0.048250578343868256, -0.08999577164649963, 0.0880742147564888, 0.06692492216825485, -0.007293592672795057, -0.0250889603048563, 0.04643361270427704, 0.051950450986623764, -0.0068991295993328094, -0.059...
0.182924
[`RedisModule\_CommandFilterArgReplace`](#RedisModule\_CommandFilterArgReplace) \* [`RedisModule\_CommandFilterArgsCount`](#RedisModule\_CommandFilterArgsCount) \* [`RedisModule\_CommandFilterGetClientId`](#RedisModule\_CommandFilterGetClientId) \* [`RedisModule\_CreateCommand`](#RedisModule\_CreateCommand) \* [`RedisM...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.009639625437557697, 0.002535981358960271, -0.06637091934680939, 0.0035882387310266495, -0.03214823454618454, -0.07945293188095093, 0.13969410955905914, -0.0134983966127038, -0.042163968086242676, -0.005022862926125526, 0.015416799113154411, -0.0927555039525032, 0.09310605376958847, -0.0...
0.041735
[`RedisModule\_StringToStreamID`](#RedisModule\_StringToStreamID) \* [`RedisModule\_StringToULongLong`](#RedisModule\_StringToULongLong) \* [`RedisModule\_StringTruncate`](#RedisModule\_StringTruncate) \* [`RedisModule\_SubscribeToKeyspaceEvents`](#RedisModule\_SubscribeToKeyspaceEvents) \* [`RedisModule\_SubscribeToSe...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-api-ref.md
master
redis
[ -0.0219742301851511, -0.005208424758166075, -0.021737273782491684, 0.00841006264090538, 0.0132682416588068, -0.0321703776717186, 0.10224732011556625, -0.02758154645562172, -0.00966913253068924, -0.04415406286716461, -0.01270477194339037, -0.04620712250471115, 0.033876750618219376, -0.05408...
0.105344
Redis modules can access Redis built-in data structures both at high level, by calling Redis commands, and at low level, by manipulating the data structures directly. By using these capabilities in order to build new abstractions on top of existing Redis data structures, or by using strings DMA in order to encode modul...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-native-types.md
master
redis
[ -0.065529964864254, -0.03436756134033203, -0.05791084095835686, 0.02073424495756626, -0.05698773264884949, -0.09908080101013184, 0.0060904985293745995, 0.0233021043241024, -0.06103372573852539, -0.030057888478040695, -0.035740096122026443, -0.01586524397134781, 0.030659811571240425, -0.015...
0.173731
is a 9 character name in the character set that includes from `A-Z`, `a-z`, `0-9`, plus the underscore `\_` and minus `-` characters. Note that \*\*this name must be unique\*\* for each data type in the Redis ecosystem, so be creative, use both lower-case and upper case if it makes sense, and try to use the convention ...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-native-types.md
master
redis
[ -0.0740438774228096, -0.04517840966582298, -0.04723077267408371, 0.02514590509235859, -0.13367319107055664, -0.04451218992471695, 0.09861290454864502, 0.04250776767730713, -0.0033613662235438824, -0.0483168326318264, 0.019930582493543625, -0.03333568945527077, 0.12194310873746872, -0.01545...
0.095315
order to let the module reclaim the memory associated with such a value. Ok, but \*why\* modules types require a 9 characters name? --- Oh, I understand you need to understand this, so here is a very specific explanation. When Redis persists to RDB files, modules specific data types require to be persisted as well. Now...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-native-types.md
master
redis
[ 0.01881609857082367, -0.006207865197211504, -0.10759474337100983, 0.04929183050990105, -0.05710061267018318, 0.016352782025933266, 0.05099950730800629, 0.06260891258716583, 0.010604120790958405, -0.04932936653494835, -0.018401097506284714, 0.06519726663827896, 0.04099494591355324, -0.01065...
0.069143
a value of a specific data type. The API uses the normal modules `RedisModule\_OpenKey()` low level key access interface in order to deal with this. This is an example of setting a native type private data structure to a Redis key: RedisModuleKey \*key = RedisModule\_OpenKey(ctx,keyname,REDISMODULE\_WRITE); struct some...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-native-types.md
master
redis
[ -0.029312385246157646, -0.023537224158644676, -0.11864938586950302, 0.07294502854347229, -0.08445187658071518, -0.06194847822189331, 0.07091186940670013, 0.08237927407026291, -0.014231903478503227, -0.02213115058839321, 0.029846081510186195, 0.004040644969791174, 0.006081124301999807, -0.0...
0.190568
you have to care those details yourself. This is the list of functions performing RDB saving and loading: void RedisModule\_SaveUnsigned(RedisModuleIO \*io, uint64\_t value); uint64\_t RedisModule\_LoadUnsigned(RedisModuleIO \*io); void RedisModule\_SaveSigned(RedisModuleIO \*io, int64\_t value); int64\_t RedisModule\_...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-native-types.md
master
redis
[ 0.04754302278161049, -0.004092744551599026, -0.11984233558177948, -0.024156825616955757, -0.08409976959228516, 0.007898344658315182, -0.012485799379646778, 0.08805178105831146, -0.08343978971242905, 0.006121041718870401, -0.03210330754518509, -0.0714777484536171, 0.04473593458533287, -0.07...
0.078926
in mind that mixing libc calls with Redis API calls will result into troubles and crashes, so if you replace calls using macros, you need to make sure that all the calls are correctly replaced, and that the code with the substituted calls will never, for example, attempt to call `RedisModule\_Free()` with a pointer all...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-native-types.md
master
redis
[ -0.009588897228240967, -0.05386849865317345, -0.10673082619905472, 0.018652064725756645, -0.05106010660529137, -0.04843149706721306, 0.026688069105148315, 0.05387771874666214, 0.011488573625683784, -0.031277406960725784, -0.03439124673604965, -0.020284729078412056, -0.0292372889816761, -0....
0.087433
Redis has a few blocking commands among the built-in set of commands. One of the most used is `BLPOP` (or the symmetric `BRPOP`) which blocks waiting for elements arriving in a list. The interesting fact about blocking commands is that they do not block the whole server, but just the client calling them. Usually the re...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-blocking-ops.md
master
redis
[ -0.10709188133478165, -0.03649653121829033, -0.06432223320007324, 0.02550407312810421, 0.03280298039317131, -0.10125011950731277, 0.006940905470401049, -0.05405903607606888, 0.06366021931171417, -0.01609537936747074, 0.004345500376075506, 0.038113079965114594, -0.020640365779399872, -0.083...
0.158077
function to have the responsibility to free the data passed if needed. To better understand how the API works, we can imagine writing a command that blocks a client for one second, and then send as reply "Hello!". Note: arity checks and other non important things are not implemented int his command, in order to take th...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-blocking-ops.md
master
redis
[ -0.0686042457818985, 0.04976751282811165, -0.06061457097530365, 0.025902315974235535, -0.04764120280742645, -0.05842529237270355, 0.0624825693666935, 0.01158866472542286, 0.058372240513563156, 0.024227144196629524, -0.02705281786620617, -0.054344650357961655, -0.007898536510765553, -0.0836...
0.201651
but the thread creation function returns an error. What to do in such a condition in order to recover? We don't want to take the client blocked, nor we want to call `UnblockClient()` because this will trigger the reply callback to be called. In this case the best thing to do is to use the following function: int RedisM...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/modules-blocking-ops.md
master
redis
[ -0.09968757629394531, -0.0003359966503921896, -0.04411478340625763, 0.011974290944635868, -0.06598770618438721, -0.011848872527480125, 0.04708974435925484, 0.008492803201079369, 0.01453245710581541, 0.01660796068608761, 0.0031750935595482588, -0.08899535238742828, -0.009528255090117455, -0...
0.088732
The modules documentation is composed of the following pages: \* Introduction to Redis modules (this file). An overview about Redis Modules system and API. It's a good idea to start your reading here. \* [Implementing native data types](/topics/modules-native-types) covers the implementation of native data types into m...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/_index.md
master
redis
[ -0.0928284227848053, -0.042633604258298874, -0.1010688990354538, 0.03070845454931259, 0.03382544964551926, -0.0780840516090393, 0.02749108150601387, 0.034405168145895004, -0.022351285442709923, -0.05878088250756264, -0.0033916013780981302, 0.037549376487731934, -0.0005523791187442839, -0.0...
0.231785
name of the module followed by a dot, and finally the command name, like in the case of `HELLOWORLD.RAND`. This way it is less likely to have collisions. Note that if different modules have colliding commands, they'll not be able to work in Redis at the same time, since the function `RedisModule\_CreateCommand` will fa...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/_index.md
master
redis
[ -0.09090466797351837, -0.04908423498272896, -0.11082995682954788, 0.019875532016158104, 0.037132084369659424, -0.13732413947582245, 0.05730465427041054, 0.009135037660598755, -0.019503289833664894, -0.07155273854732513, 0.021980829536914825, 0.01458335667848587, 0.07295633852481842, -0.059...
0.155025
library, nor they need to be compiled with a specific `redismodule.h` file. In order to create a new module, just copy a recent version of `redismodule.h` in your source tree, link all the libraries you want, and create a dynamic library having the `RedisModule\_OnLoad()` function symbol exported. The module will be ab...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/_index.md
master
redis
[ -0.020976442843675613, -0.04790358617901802, -0.14382125437259674, -0.0030604396015405655, 0.022558346390724182, -0.05652804672718048, -0.0012623267248272896, 0.042157139629125595, -0.02356063760817051, -0.09073712676763535, 0.00012363291170913726, -0.024149904027581215, 0.0092216981574893, ...
0.089411
\*/ } ## Accessing Redis keys from modules Most Redis modules, in order to be useful, have to interact with the Redis data space (this is not always true, for example an ID generator may never touch Redis keys). Redis modules have two different APIs in order to access the Redis data space, one is a low level API that p...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/_index.md
master
redis
[ -0.107613705098629, -0.04589592665433884, -0.0643669068813324, 0.007323624100536108, 0.013685262762010098, -0.12275972962379456, 0.015442407689988613, 0.08048021793365479, 0.04740913584828377, -0.05298205837607384, 0.02430545724928379, 0.042873721569776535, 0.032332196831703186, -0.0528684...
0.200596
\*\*R\*\* -- This modifier, when `!` is given, tells to suppress replicas propagation: the command will be propagated only to the AOF if enabled. The function returns a `RedisModuleCallReply` object on success, on error NULL is returned. NULL is returned when the command name is invalid, the format specifier uses chara...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/_index.md
master
redis
[ -0.030292462557554245, -0.040399741381406784, -0.09645705670118332, 0.06061948090791702, 0.005380000453442335, -0.07532567530870438, 0.056479763239622116, 0.016624199226498604, 0.026910515502095222, -0.015709271654486656, 0.04464053362607956, -0.04322238266468048, 0.0313723124563694, -0.03...
0.20143
here forever, so should not be considered part of the API. If you use automatic memory management (explained later in this document) you don't need to free replies (but you still could if you wish to release memory ASAP). ## Returning values from Redis commands Like normal Redis commands, new commands implemented via m...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/_index.md
master
redis
[ -0.019746726378798485, -0.016117673367261887, -0.07750649750232697, 0.08626659959554672, -0.010862013325095177, -0.07568985223770142, 0.047102801501750946, 0.058691877871751785, 0.023718183860182762, 0.012181974947452545, -0.02373434416949749, 0.003156084567308426, 0.03128500282764435, -0....
0.143043
This creates a 100 items array having as last element a 10 items array. ## Arity and type checks Often commands need to check that the number of arguments and type of the key is correct. In order to report a wrong arity, there is a specific function called `RedisModule\_WrongArity()`. The usage is trivial: if (argc != ...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/_index.md
master
redis
[ 0.0774933472275734, 0.02898193709552288, -0.09755667299032211, 0.029234865680336952, -0.11253123730421066, -0.04185290262103081, 0.14450429379940033, 0.025389203801751137, -0.0371154360473156, 0.027009034529328346, -0.016900504007935524, -0.02850431762635708, 0.09503266215324402, -0.074237...
0.12118
with the addition of an empty type, that signals the key pointer is associated with an empty key that does not yet exists. ## Creating new keys To create a new key, open it for writing and then write to it using one of the key writing functions. Example: RedisModuleKey \*key; key = RedisModule\_OpenKey(ctx,argv[1],REDI...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/_index.md
master
redis
[ 0.016495684161782265, -0.041574928909540176, -0.07252458482980728, 0.07981795072555542, -0.04974240064620972, -0.05213439464569092, 0.0795007050037384, 0.017677582800388336, 0.05040644109249115, -0.02850533276796341, 0.04453568160533905, -0.013292279094457626, 0.05124076455831528, -0.09853...
0.127463
`WRITE` mode. DMA pointers are only valid if no other operations are performed with the key before using the pointer, after the DMA call. Sometimes when we want to manipulate strings directly, we need to change their size as well. For this scope, the `RedisModule\_StringTruncate` function is used. Example: RedisModule\...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/_index.md
master
redis
[ 0.028928881511092186, 0.04487605765461922, 0.025212744250893593, 0.038291748613119125, -0.12325108051300049, -0.04839548468589783, 0.047497160732746124, 0.10922101885080338, -0.022511940449476242, 0.031781043857336044, -0.014010250568389893, 0.03864359110593796, 0.015966279432177544, -0.07...
0.089897
so that the AOF and replication effects are the same as executing a single command. Note that `Call()` replication and `Replicate()` replication have a rule, in case you want to mix both forms of replication (not necessarily a good idea if there are simpler approaches). Commands replicated with `Call()` are always the ...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/_index.md
master
redis
[ -0.024952629581093788, -0.0681365430355072, -0.11887367814779282, 0.05564137548208237, -0.027313850820064545, -0.10398594290018082, 0.018110228702425957, -0.003373066196218133, 0.11497806757688522, 0.05923507362604141, 0.01105253491550684, 0.05601806566119194, 0.01811334863305092, -0.07072...
0.182421
the overhead of the allocations is small, and more important, the memory allocated is automatically released when the command returns. So in general short living allocations are a good candidates for the pool allocator. ## Writing commands compatible with Redis Cluster Documentation missing, please check the following ...
https://github.com/redis/redis-doc/blob/master/docs/reference/modules/_index.md
master
redis
[ 0.005254335235804319, -0.05115840584039688, -0.11219459027051926, 0.04850009083747864, -0.012576061300933361, -0.030068008229136467, 0.033502403646707535, 0.022260362282395363, -0.01602000556886196, 0.01326574943959713, 0.0355059914290905, -0.017155738547444344, 0.006481910590082407, -0.02...
0.135171
When Redis is used as a cache, it is often convenient to let it automatically evict old data as you add new data. This behavior is well known in the developer community, since it is the default behavior for the popular \*memcached\* system. This page covers the more general topic of the Redis `maxmemory` directive used...
https://github.com/redis/redis-doc/blob/master/docs/reference/eviction/index.md
master
redis
[ 0.018086032941937447, -0.01702773943543434, -0.10806090384721756, 0.013294394128024578, -0.021005012094974518, -0.1253521889448166, 0.009075612761080265, 0.055357955396175385, 0.025559037923812866, 0.011950260028243065, -0.0012651303550228477, 0.10700974613428116, -0.012167608365416527, -0...
0.122459
mainly useful when you want to use a single instance for both caching and to have a set of persistent keys. However it is usually a better idea to run two Redis instances to solve such a problem. It is also worth noting that setting an `expire` value to a key costs memory, so using a policy like \*\*allkeys-lru\*\* is ...
https://github.com/redis/redis-doc/blob/master/docs/reference/eviction/index.md
master
redis
[ -0.045149534940719604, -0.023931434378027916, -0.04955665394663811, 0.020157789811491966, -0.019418800249695778, -0.07965882122516632, 0.04501134529709816, 0.026792190968990326, 0.08100210875272751, 0.025429263710975647, 0.03334410861134529, 0.08283527940511703, 0.04460907354950905, -0.077...
0.1655
that are among the latest accessed are still retained by Redis 2.8. Using a sample size of 10 in Redis 3.0 the approximation is very close to the theoretical performance of Redis 3.0. Note that LRU is just a model to predict how likely a given key will be accessed in the future. Moreover, if your data access pattern cl...
https://github.com/redis/redis-doc/blob/master/docs/reference/eviction/index.md
master
redis
[ 0.004714068491011858, -0.08490953594446182, -0.08163472265005112, 0.028139492496848106, 0.05830435827374458, -0.13117434084415436, -0.040881481021642685, 0.04515478387475014, -0.007315253373235464, -0.014310010708868504, -0.0005768015398643911, 0.09217457473278046, -0.05092412978410721, -0...
0.017487
the factor, the better is the resolution of the counter for low accesses, according to the following table: ``` +--------+------------+------------+------------+------------+------------+ | factor | 100 hits | 1000 hits | 100K hits | 1M hits | 10M hits | +--------+------------+------------+------------+------------+---...
https://github.com/redis/redis-doc/blob/master/docs/reference/eviction/index.md
master
redis
[ 0.07868649810552597, -0.02317587472498417, -0.12772801518440247, 0.018361292779445648, -0.061254315078258514, -0.0290705393999815, 0.0017525963485240936, 0.06260289251804352, 0.027814770117402077, 0.03278391435742378, 0.003354826243594289, -0.03194321319460869, 0.08645419776439667, -0.0284...
0.038401
This quick start guide shows you how to: 1. Get started with Redis 2. Store data under a key in Redis 3. Retrieve data with a key from Redis 4. Scan the keyspace for keys that match a specific pattern The examples in this article refer to a simple bicycle inventory. ## Setup The easiest way to get started with Redis is...
https://github.com/redis/redis-doc/blob/master/docs/get-started/data-store.md
master
redis
[ 0.023406462743878365, -0.040021851658821106, -0.09293578565120697, -0.015310842543840408, -0.050688646733760834, -0.00974026508629322, 0.01445914525538683, 0.04402565956115723, -0.02028047852218151, 0.02022971212863922, 0.050825268030166626, -0.04621502012014389, 0.1060614064335823, -0.083...
0.061411
quick start guides: \* [Redis as a document database](/docs/get-started/document-database/) \* [Redis as a vector database](/docs/get-started/vector-database/)
https://github.com/redis/redis-doc/blob/master/docs/get-started/data-store.md
master
redis
[ -0.01995522528886795, -0.044236574321985245, -0.14815719425678253, 0.02665167860686779, -0.016771826893091202, -0.02076047845184803, -0.009145836345851421, 0.05814152956008911, -0.07242406904697418, -0.0023553769569844007, -0.01382744312286377, 0.05875733867287636, 0.04991431161761284, -0....
0.125943
## How is Redis different from other key-value stores? \* Redis has a different evolution path in the key-value DBs where values can contain more complex data types, with atomic operations defined on those data types. Redis data types are closely related to fundamental data structures and are exposed to the programmer ...
https://github.com/redis/redis-doc/blob/master/docs/get-started/faq.md
master
redis
[ 0.00032234456739388406, -0.04825826361775398, -0.08537387102842331, 0.03000488132238388, -0.010869394056499004, -0.07810012251138687, -0.0042182160541415215, 0.06228521466255188, 0.08001960813999176, 0.03010350465774536, -0.037960465997457504, 0.08741151541471481, 0.043130919337272644, -0....
0.132412
you use Redis with a disk-based database? Yes, a common design pattern involves taking very write-heavy small data in Redis (and data you need the Redis data structures to model your problem in an efficient way), and big \*blobs\* of data into an SQL or eventually consistent on-disk database. Similarly sometimes Redis ...
https://github.com/redis/redis-doc/blob/master/docs/get-started/faq.md
master
redis
[ 0.023978527635335922, -0.012270966544747353, -0.07130301743745804, 0.030028710141777992, -0.04364199936389923, -0.10219905525445938, 0.03489712253212929, 0.06152823194861412, -0.021746309474110603, 0.038131970912218094, -0.04820018634200096, 0.100807324051857, 0.037586040794849396, -0.0506...
0.098836
becomes your bottleneck with Redis, as usually Redis is either memory or network bound. For instance, when using pipelining a Redis instance running on an average Linux system can deliver 1 million requests per second, so if your application mainly uses O(N) or O(log(N)) commands, it is hardly going to use too much CPU...
https://github.com/redis/redis-doc/blob/master/docs/get-started/faq.md
master
redis
[ 0.01649402640759945, -0.06505552679300308, -0.06004071608185768, -0.012282679788768291, -0.0010973169701173902, -0.0996415913105011, -0.023290254175662994, 0.020512666553258896, 0.04713033139705658, -0.012255738489329815, -0.0563010610640049, 0.04343252256512642, 0.018670013174414635, -0.0...
0.059089
--- title: "Quick starts" linkTitle: "Quick starts" hideListLinks: true weight: 20 description: > Redis quick start guides aliases: - /docs/getting-started/ --- Redis can be used as a database, cache, streaming engine, message broker, and more. The following quick start guides will show you how to use Redis for the fo...
https://github.com/redis/redis-doc/blob/master/docs/get-started/_index.md
master
redis
[ -0.06022506579756737, -0.03519003838300705, -0.10114296525716782, 0.0639282688498497, 0.03592398762702942, 0.007119201123714447, 0.04609547182917595, 0.08222471922636032, -0.04245782643556595, -0.022662436589598656, 0.008825133554637432, 0.05381380021572113, 0.009315299801528454, -0.057840...
0.059791
{{< docs/hero-simple key="hero" >}} --- ## Overview \_Grafana Open Source Software (OSS)\_ enables you to query, visualize, alert on, and explore your metrics, logs, and traces wherever they're stored. Grafana data source plugins enable you to query data sources including time series databases like Prometheus and Cloud...
https://github.com/grafana/grafana/blob/main/docs/sources/_index.md
main
grafana
[ -0.053684379905462265, 0.010973703116178513, -0.08966420590877533, 0.03500949591398239, 0.007962479256093502, -0.08893789350986481, -0.07616965472698212, 0.02541094273328781, -0.014078727923333645, 0.040807757526636124, -0.031832873821258545, -0.015231710858643055, -0.01998092420399189, -0...
0.157837
# Troubleshoot general data source issues This page provides solutions to common issues that apply across data sources in Grafana. For troubleshooting specific to a data source, refer to the troubleshooting page within each data source's documentation. ## Connection errors These errors occur when Grafana can't reach th...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/troubleshooting.md
main
grafana
[ -0.08605057001113892, 0.030425723642110825, -0.055838897824287415, 0.0005450528115034103, -0.08664039522409439, -0.08403045684099197, -0.10836780071258545, -0.06345862150192261, -0.031056314706802368, 0.039805930107831955, 0.0033427183516323566, -0.06824974715709686, 0.007148471660912037, ...
0.003601
credentials have read access to the specific resource or index being queried. | ### Query timeout \*\*Symptoms:\*\* - Queries run for a long time then fail - Error messages mention timeout or query limits \*\*Solutions:\*\* 1. Narrow the dashboard time range to reduce the volume of data. 1. Add filters to the query to ...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/troubleshooting.md
main
grafana
[ 0.015574365854263306, -0.0048059201799333096, -0.023127015680074692, 0.01817004568874836, -0.018111299723386765, -0.045596010982990265, -0.017645027488470078, -0.011858686804771423, 0.023031409829854965, 0.08550897985696793, -0.012625990435481071, -0.05039326846599579, 0.062082432210445404, ...
-0.03841
# Data sources A \_data source\_ in Grafana is a connection to a storage backend that holds your data, such as a Prometheus server, a Loki instance, a SQL database, or a cloud monitoring service. Grafana queries data sources to retrieve the stored data (e.g. metrics, logs, traces, and profiles) that it then visualizes ...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/_index.md
main
grafana
[ -0.0844251811504364, -0.03768407180905342, -0.09786549210548401, 0.0709415152668953, -0.05118713527917862, -0.08698103576898575, 0.01939116045832634, -0.01972363330423832, 0.010133431293070316, 0.07346417009830475, -0.03170891851186752, -0.06766101717948914, 0.0661483034491539, -0.01834474...
0.138749
in Grafana, and common options and user interface elements across all query editors, refer to [Query and transform data](ref:query-transform-data). ## Provision data sources You can define and manage data sources as code using the Grafana provisioning system. This lets you configure data sources through YAML files or T...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/_index.md
main
grafana
[ -0.09860990196466446, -0.01322217471897602, -0.06250905990600586, 0.04229624569416046, -0.05150303244590759, -0.09143451601266861, -0.035159654915332794, -0.04257003590464592, -0.04073728248476982, 0.08717534691095352, -0.0005698824534192681, -0.0548262819647789, 0.03676564246416092, -0.07...
0.116813
that lets you define rules to link data between any data sources. Refer to [Correlations](ref:correlations) for details. ## Troubleshoot data sources If you run into issues with a data source, refer to [Troubleshoot data sources](ref:troubleshoot-data-sources) for solutions to common problems like connection errors, au...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/_index.md
main
grafana
[ -0.09890536218881607, -0.06821367144584656, -0.11876540631055832, 0.03604218363761902, 0.0004186343867331743, -0.05260872840881348, -0.03379742056131363, -0.011477570980787277, -0.02259792946279049, 0.002569780219346285, -0.009197057224810123, -0.06738893687725067, 0.094950370490551, 0.006...
0.063893
# Google Cloud Monitoring data source Google Cloud Monitoring (formerly Stackdriver) is Google Cloud Platform's native monitoring and observability service that collects metrics, events, and metadata from GCP resources, hosted uptime probes, and application instrumentation. The Google Cloud Monitoring data source in Gr...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/_index.md
main
grafana
[ -0.11044367402791977, -0.07323005795478821, -0.042308490723371506, -0.00816575437784195, -0.0495222769677639, -0.05382532626390457, 0.01899099163711071, -0.0683758482336998, -0.02037682756781578, 0.06635092198848724, -0.01593431457877159, -0.09746398031711578, 0.023478064686059952, -0.0225...
0.061934
# Google Cloud Monitoring alerting The Google Cloud Monitoring data source supports [Grafana Alerting](https://grafana.com/docs/grafana//alerting/), allowing you to create alert rules based on GCP metrics and Service Level Objectives (SLOs). You can monitor your Google Cloud environment and receive notifications when s...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/alerting/index.md
main
grafana
[ -0.11056685447692871, -0.04363192990422249, -0.004497773479670286, 0.003425158094614744, -0.01703551970422268, -0.06349601596593857, 0.062233611941337585, -0.09500272572040558, 0.004858100786805153, 0.02763189561665058, -0.0074380794540047646, -0.08911510556936264, 0.06422300636768341, -0....
0.016012
- \*\*Query type\*\*: Service Level Objectives (SLO) - \*\*Project\*\*: Select your GCP project - \*\*Service\*\*: Select your SLO service - \*\*SLO\*\*: Select your SLO - \*\*Selector\*\*: SLO Error Budget Remaining 1. Add expressions: - \*\*Reduce\*\*: Last - \*\*Threshold\*\*: Is below 0.2 (20% remaining) 1. Set eva...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/alerting/index.md
main
grafana
[ 0.014627235010266304, 0.0003865828039124608, -0.023756684735417366, 0.05838420242071152, -0.023427199572324753, -0.04747837409377098, 0.09834419935941696, -0.007785440422594547, -0.018854742869734764, 0.06685445457696915, -0.02428455278277397, -0.07580512017011642, 0.07753544300794601, -0....
0.039379
to diagnose and resolve common issues. ### Alerts not firing - Check that the query returns numeric data in Explore. - Ensure the evaluation interval allows enough time for data to be available. - Verify the threshold is set correctly (remember that many GCP metrics return decimals, not percentages). - Review the alert...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/alerting/index.md
main
grafana
[ -0.019711105152964592, -0.02300783060491085, 0.03766470402479172, 0.06554309278726578, -0.027414066717028618, -0.059359751641750336, 0.013632426038384438, -0.10107040405273438, 0.018791353330016136, 0.031804684549570084, -0.014827551320195198, -0.07024865597486496, 0.08263608068227768, -0....
-0.024232
# Configure the Google Cloud Monitoring data source This document provides instructions for configuring the Google Cloud Monitoring data source in Grafana. ## Before you begin Before you begin, ensure you have the following: - \*\*Grafana permissions:\*\* You must have the `Organization administrator` role to configure...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/configure/index.md
main
grafana
[ -0.13385623693466187, -0.050145864486694336, -0.029294554144144058, -0.026324786245822906, -0.07324882596731186, -0.062445275485515594, -0.015288825146853924, -0.09213864058256149, -0.054965391755104065, 0.0910855308175087, 0.009376454167068005, -0.0836324468255043, -0.012434864416718483, ...
0.000582
`.json` key file, click \*\*Click to browse files\*\* to upload, or use \*\*Paste JWT Token\*\* or \*\*Fill In JWT Token manually\*\*. | ### Forward OAuth Identity These settings appear when you select \*\*Forward OAuth Identity\*\* as the authentication type. | Setting | Description | | ------------------- | ---------...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/configure/index.md
main
grafana
[ -0.07240395992994308, 0.012262250296771526, -0.017491916194558144, -0.007038209121674299, 0.019606012850999832, -0.057942040264606476, -0.047199226915836334, 0.07964974641799927, 0.040917012840509415, -0.03352495655417442, -0.02402593195438385, 0.0065517001785337925, -0.012183242477476597, ...
0.043117
can provision the Google Cloud Monitoring data source using [Terraform](https://www.terraform.io/) with the [Grafana Terraform provider](https://registry.terraform.io/providers/grafana/grafana/latest/docs). For more information about provisioning resources with Terraform, refer to the [Grafana as code using Terraform](...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/configure/index.md
main
grafana
[ -0.07821570336818695, -0.01582108624279499, -0.05422104522585869, 0.009734062477946281, -0.046170104295015335, -0.05505523085594177, -0.0244548711925745, -0.11420801281929016, -0.027712000533938408, 0.10018089413642883, -0.02152673527598381, -0.1112457662820816, 0.04108966141939163, -0.016...
-0.017556
# Google authentication This document explains how to configure authentication between Grafana and Google Cloud Platform (GCP). You must configure authentication before you can use the Google Cloud Monitoring data source to query metrics and SLOs. All requests to Google APIs are performed on the server-side by the Graf...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/google-authentication/index.md
main
grafana
[ -0.13911795616149902, -0.03338548168540001, -0.037165794521570206, -0.049080513417720795, -0.0910273939371109, -0.06268792599439621, 0.014964096248149872, -0.07946523278951645, -0.03199395537376404, 0.06653725355863571, 0.00483643589541316, -0.08585647493600845, 0.02660275436937809, -0.052...
-0.033208
file in Grafana. The service account can now access all configured projects. ## Use GCE Default Service Account When Grafana runs on a Google Compute Engine (GCE) virtual machine, it can automatically retrieve credentials from the GCE metadata server. This method doesn't require you to create or manage key files. ### P...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/google-authentication/index.md
main
grafana
[ -0.1145775318145752, -0.044996846467256546, -0.07271789759397507, -0.07172892987728119, -0.08805480599403381, -0.04305661842226982, 0.0012201776262372732, -0.04767104983329773, -0.013173064216971397, 0.08505246043205261, -0.03719020262360573, -0.09012194722890854, 0.013780783861875534, -0....
0.026774
to verify the connection. {{< admonition type="note" >}} Service account impersonation isn't compatible with Forward OAuth Identity. The data source authenticates as the signed-in user, so there's no service account to impersonate. {{< /admonition >}} ## Configure service account impersonation Service account impersona...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/google-authentication/index.md
main
grafana
[ -0.18203142285346985, 0.04668819531798363, -0.06920751184225082, -0.031992193311452866, -0.038850873708724976, -0.12451247870922089, 0.07064466178417206, -0.03776369243860245, 0.022626368328928947, 0.04688958823680878, -0.013684476725757122, -0.08139632642269135, 0.04185515269637108, 0.020...
0.075182
# Google Cloud Monitoring template variables Instead of hard-coding details such as server, application, and sensor names in metric queries, you can use variables. Grafana lists these variables in dropdown select boxes at the top of the dashboard to help you change the data displayed in your dashboard. Grafana refers t...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/template-variables/index.md
main
grafana
[ -0.08813177794218063, 0.012186331674456596, -0.046359315514564514, 0.04002177342772484, -0.05015173926949501, -0.02252160757780075, 0.052281010895967484, -0.05272959545254707, -0.02272658608853817, 0.04259709268808365, -0.031238947063684464, -0.0967581644654274, 0.03366006910800934, -0.037...
0.052089
# Troubleshoot Google Cloud Monitoring data source issues This document provides solutions to common issues you may encounter when configuring or using the Google Cloud Monitoring data source. For configuration instructions, refer to [Configure Google Cloud Monitoring](https://grafana.com/docs/grafana//datasources/goog...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/troubleshooting/index.md
main
grafana
[ -0.10727240890264511, 0.0036167886573821306, -0.015899568796157837, 0.0040899054147303104, -0.020026249811053276, -0.07247089594602585, -0.0010951425647363067, -0.1117321103811264, -0.0269828662276268, 0.06570953875780106, 0.03330342099070549, -0.09591864794492722, 0.03538224473595619, -0....
-0.03725
authentication includes the `https://www.googleapis.com/auth/monitoring.read` scope. Refer to [Configure the Google OAuth scope](https://grafana.com/docs/grafana//datasources/google-cloud-monitoring/google-authentication/#configure-the-google-oauth-scope). 1. After you add the scope, sign out of Grafana, revoke the exi...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/troubleshooting/index.md
main
grafana
[ -0.13522258400917053, 0.053066253662109375, -0.025494707748293877, -0.007873645052313805, -0.06439170241355896, -0.08794070035219193, 0.018722303211688995, -0.10473958402872086, -0.010356063023209572, 0.06112845242023468, -0.02570478618144989, -0.05210113897919655, 0.05441397428512573, -0....
-0.031709
your MQL syntax using the [MQL reference documentation](https://cloud.google.com/monitoring/mql/reference). 1. Check for typos in metric types, label names, or function names. 1. Ensure time range syntax is valid in your query. 1. Test the query in the GCP Console Metrics Explorer before using it in Grafana. ### "Too m...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/troubleshooting/index.md
main
grafana
[ -0.07700461894273758, -0.028294522315263748, -0.005758930463343859, 0.010974658653140068, -0.13824282586574554, -0.04785657674074173, 0.007224178407341242, -0.0570109486579895, -0.010111362673342228, 0.08892225474119186, -0.040893785655498505, -0.10488461703062057, 0.09589145332574844, -0....
-0.012283
location). 1. Look for Google Cloud Monitoring-specific entries that include request and response details. 1. Reset the log level to `info` after troubleshooting to avoid excessive log volume. ## Get additional help If you've tried the solutions above and still encounter issues: 1. Check the [Grafana community forums](...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/troubleshooting/index.md
main
grafana
[ -0.09688154608011246, -0.0591818168759346, 0.004794014152139425, -0.009903628379106522, -0.046697717159986496, -0.1116752177476883, -0.036805279552936554, -0.1077960878610611, -0.0072833276353776455, 0.1096983477473259, -0.035298414528369904, -0.05931877717375755, -0.028230158612132072, -0...
-0.046362
# Google Cloud Monitoring query editor This topic explains querying specific to the Google Cloud Monitoring data source. For general documentation on querying data sources in Grafana, see [Query and transform data](https://grafana.com/docs/grafana//panels-visualizations/query-transform-data/). ## Query types The Google...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/query-editor/index.md
main
grafana
[ -0.07159976661205292, 0.00844072550535202, -0.050603725016117096, 0.03528678044676781, -0.047648292034864426, -0.021626705303788185, 0.03529905155301094, -0.07960786670446396, 0.00017293881683144718, 0.03227727860212326, -0.010152443312108517, -0.07504349946975708, 0.07362968474626541, -0....
0.045846
in the range of 1 to 3, a dash, and then either an "a" or an "f". You don't need leading and trailing slashes when you create these regular expressions. ### Configure pre-processing options The query editor displays pre-processing options when the selected metric has a metric type of `DELTA` or `CUMULATIVE`. - The \*\*...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/query-editor/index.md
main
grafana
[ -0.07827950268983841, -0.010727099142968655, -0.029416602104902267, -0.0036239251494407654, -0.08650725334882736, -0.011748012155294418, -0.0028580832295119762, -0.04499199613928795, 0.04365812987089157, 0.015294519253075123, 0.00883797649294138, -0.12827923893928528, 0.003003072226420045, ...
0.051415
keys. By default, Grafana shows the metric name and labels, which can be long and difficult to read. You can use patterns in the alias field to customize the legend key's format: | Alias pattern | Description | Alias pattern example | Example result | | -------------------------------- | -------------------------------...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/query-editor/index.md
main
grafana
[ -0.07548101246356964, 0.08544009178876877, -0.047706104815006256, -0.012693102471530437, -0.10329315811395645, 0.017334118485450745, -0.01374926045536995, 0.013662080280482769, 0.05626388266682625, -0.048170305788517, -0.034890975803136826, -0.09539041668176651, -0.0027009560726583004, -0....
0.002975
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | \*\*Alias by\*\* | Control the format of legend keys. Refer to [Set alias patterns for MQL queries](#set-alias-patterns-for-mql-queries) for avai...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/query-editor/index.md
main
grafana
[ -0.019786318764090538, 0.06984517723321915, -0.014052876271307468, 0.001033096225000918, -0.0467340424656868, 0.015527735464274883, -0.05116964876651764, 0.002373968018218875, 0.045806776732206345, -0.011080671101808548, 0.026637786999344826, -0.06868670135736465, 0.0988130122423172, -0.05...
-0.099341
# Google Cloud Monitoring annotations [Annotations](https://grafana.com/docs/grafana//dashboards/build-dashboards/annotate-visualizations/) overlay rich event information on top of graphs. You can use annotations to mark important events, deployments, or incidents on your dashboards. ## Before you begin Before you conf...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/google-cloud-monitoring/annotations/index.md
main
grafana
[ -0.07875043153762817, 0.03404220938682556, -0.027568228542804718, -0.018936356529593468, 0.03964276611804962, -0.0070788259617984295, 0.006800146773457527, -0.04415472224354744, 0.05202273651957512, 0.08393477648496628, -0.07473202049732208, -0.10924414545297623, -0.005315740127116442, 0.0...
0.064758
# Parca data source Parca is a continuous profiling database for analysis of CPU and memory usage, down to the line number and throughout time. Grafana ships with built-in support for Parca, so you can add it as a data source and start querying your profiles in [Explore](https://grafana.com/docs/grafana//explore/). Ref...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/parca/_index.md
main
grafana
[ 0.0026535114739090204, -0.05308813974261284, -0.18445757031440735, 0.03237544000148773, -0.06431781500577927, -0.09344090521335602, -0.053249336779117584, 0.09114566445350647, -0.06082053482532501, -0.01921355538070202, -0.024813838303089142, -0.03334660828113556, -0.0063700079917907715, -...
0.040473
# Configure the Parca data source This document explains how to configure the Parca data source in Grafana. You can configure the data source using the Grafana UI, a YAML provisioning file, or Terraform. If you make any changes in the UI, select \*\*Save & test\*\* to preserve those changes. ## Before you begin Before ...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/parca/configure/index.md
main
grafana
[ -0.019547389820218086, -0.03965691104531288, -0.13108471035957336, -0.0041814506985247135, -0.08041626214981079, -0.08091422915458679, -0.125640407204628, -0.050774093717336655, 0.03397288918495178, 0.10119058191776276, 0.009075580164790154, -0.06740955263376236, -0.015128472819924355, -0....
-0.04821
server has the secure SOCKS proxy feature enabled. {{< /admonition >}} | Setting | Description | | ----------- | ---------------------------------------------------------------------------- | | \*\*Enabled\*\* | Toggle to route requests to the Parca instance through a secure SOCKS proxy. | ## Verify the connection Clic...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/parca/configure/index.md
main
grafana
[ -0.10382605344057083, -0.03483746200799942, -0.10833268612623215, 0.010256554000079632, -0.05585276708006859, -0.06769271939992905, -0.03794148191809654, -0.04445815458893776, 0.02914113737642765, 0.020469820126891136, 0.03131532669067383, 0.027451803907752037, 0.021737748757004738, 0.0216...
-0.066769
# Parca template variables Instead of hard-coding label values in your profiling queries, you can use template variables to create dynamic, reusable dashboards. Variables appear as drop-down menus at the top of the dashboard, making it easy to switch between services, instances, or environments without editing queries....
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/parca/template-variables/index.md
main
grafana
[ -0.05726725980639458, 0.0377909354865551, -0.14256314933300018, 0.0581873320043087, -0.0841166228055954, 0.01669951342046261, 0.003594073001295328, 0.04685046151280403, -0.020469319075345993, 0.003265528939664364, -0.018894687294960022, -0.08330216258764267, 0.03257453814148903, 0.02856379...
0.041908
another data source. - \*\*Label selector only:\*\* Variables are interpolated in the label selector field. The profile type drop-down doesn't support variables. - \*\*No free-form filters:\*\* Parca doesn't support [free-form filters](https://grafana.com/docs/grafana//dashboards/variables/add-template-variables/#add-a...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/parca/template-variables/index.md
main
grafana
[ -0.06459082663059235, 0.024204354733228683, -0.0833936408162117, 0.05171388387680054, -0.09236425161361694, -0.014690212905406952, -0.024601763114333153, -0.00003911454405169934, -0.04022306948900223, -0.025246987119317055, 0.006213585380464792, -0.12564490735530853, -0.009653928689658642, ...
-0.022062
# Troubleshoot Parca data source issues This page provides solutions to common issues you might encounter when configuring or using the Parca data source. For configuration instructions, refer to [Configure the Parca data source](https://grafana.com/docs/grafana//datasources/parca/configure/). ## Connection errors Thes...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/parca/troubleshooting/index.md
main
grafana
[ -0.0491240955889225, -0.04445580765604973, -0.10774077475070953, 0.0027219068724662066, -0.07478636503219604, -0.06543504446744919, -0.14137640595436096, -0.025500455871224403, 0.04125556722283363, 0.05013880878686905, 0.03830303996801376, -0.04569077864289284, -0.013983498327434063, -0.02...
-0.065719
issues relate to the query editor interface. ### Profile type drop-down is empty \*\*Symptoms:\*\* - The profile type selector shows no options. - The button text reads \*\*Select a profile type\*\* with nothing to choose. \*\*Possible causes and solutions:\*\* | Cause | Solution | | -------------------------- | ------...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/parca/troubleshooting/index.md
main
grafana
[ -0.01329096220433712, 0.006457135546952486, -0.07709459960460663, 0.101310133934021, 0.0017688377993181348, -0.0015846854075789452, 0.0368502140045166, 0.06153383105993271, -0.05620304122567177, 0.027115141972899437, 0.06700846552848816, -0.15970851480960846, 0.08660634607076645, -0.040140...
-0.053436
messages include: - `"Failed to get profile types"` -- profile type loading failed. - `"Failed to get label names"` -- label autocomplete data failed to load. - `"Failed to process query"` -- a query to Parca returned an error. - `"Failed to unmarshall query"` -- the query JSON couldn't be parsed. 1. Reset the log leve...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/parca/troubleshooting/index.md
main
grafana
[ -0.07854469865560532, -0.03436934947967529, -0.0810236930847168, 0.00495276041328907, -0.07169334590435028, -0.04180072993040085, -0.050225239247083664, 0.006706783547997475, -0.043808143585920334, 0.017166875302791595, 0.0246172733604908, -0.0706329494714737, -0.021019402891397476, 0.0356...
-0.025148
# Parca query editor This document explains how to use the Parca query editor to query and visualize continuous profiling data. The query editor gives you access to a profile type selector, a label selector with autocomplete, and collapsible options for controlling query behavior. ## Before you begin Before using the q...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/parca/query-editor/index.md
main
grafana
[ 0.011844757944345474, -0.024102400988340378, -0.16954173147678375, 0.04817160591483116, -0.07919556647539139, -0.048955611884593964, -0.05221515893936157, 0.03543820604681969, -0.0386640802025795, -0.0015891348011791706, -0.005185830406844616, -0.06530625373125076, -0.010815821588039398, -...
0.036638
profile visualized as a flame graph. | | \*\*Both\*\* | Returns both metric and profile data. Only available in Explore. | {{< admonition type="note" >}} The \*\*Both\*\* option is only available in [Explore](https://grafana.com/docs/grafana//explore/). In dashboard panels, you can select either \*\*Metric\*\* or \*\*P...
https://github.com/grafana/grafana/blob/main/docs/sources/datasources/parca/query-editor/index.md
main
grafana
[ -0.06140195578336716, 0.002514739753678441, -0.10651140660047531, 0.05523649603128433, -0.08961760252714157, -0.0021360416430979967, 0.017490096390247345, -0.009310632944107056, -0.01614432968199253, -0.0389719121158123, -0.04188697785139084, -0.09576697647571564, 0.012630356475710869, 0.0...
0.060709