diff --git a/doc/DOC.md b/doc/DOC.md index 85d3bed..7cae037 100644 --- a/doc/DOC.md +++ b/doc/DOC.md @@ -10,23 +10,39 @@ Real time data are sent to their respective server's Redis pubsub channel # Redis database +## Geolocalisation + | Module | Feature | Key name | Key type | Key content | |---------------------|---------------------------------------|------------------------------------|----------|--------------------------| -| Geolocalisation | Coordinate per day | ```GEO_COORD:date``` | zset |{lat: xx, lon: yy} | -| Geolocalisation | Country per day | ```GEO_COUNTRY:date``` | zset |ISO_CODE | -| Geolocalisation | Coordinate and value per radius | ```GEO_RAD:date``` | geo | { categ: xx, value: yy } | -| Contribution | Contribution per day (monthly points) | ```CONTRIB_DAY:date``` | zset | org | -| Contribution | Category contributed per day | ```CONTRIB_CATEG:date:categ``` | zset | org | -| Contribution | Last org that contributed | ```CONTRIB_LAST:date``` | zset | org | -| Contribution | All org collected from the ZMQ | ```CONTRIB_ALL_ORG``` | set | org | -| Contribution | Acquired contribution requirement | ```CONTRIB_ORG:org:req```
| string | integer | +| geo_helper | Coordinate per day | ```GEO_COORD:date``` | zset |{lat: xx, lon: yy} | +| geo_helper | Country per day | ```GEO_COUNTRY:date``` | zset |ISO_CODE | +| geo_helper | Coordinate and value per radius | ```GEO_RAD:date``` | geo | { categ: xx, value: yy } | + +## Contribution + +| Module | Feature | Key name | Key type | Key content | +|---------------------|---------------------------------------|------------------------------------|----------|--------------------------| +| contributor_helper | Contribution per day (monthly points) | ```CONTRIB_DAY:date``` | zset | org | +| contributor_helper | Category contributed per day | ```CONTRIB_CATEG:date:categ``` | zset | org | +| contributor_helper | Last org that contributed | ```CONTRIB_LAST:date``` | zset | org | +| contributor_helper | All org collected from the ZMQ | ```CONTRIB_ALL_ORG``` | set | org | +| contributor_helper | Acquired contribution requirement | ```CONTRIB_ORG:org:req```
| string | integer | | | ```req``` is one of: | ```points```
```CONTRIB_REQ_i```
```ATTR_WEEK_COUNT```
```PROP_WEEK_COUNT```
```SIGHT_WEEK_COUNT```
```EVENT_WEEK_COUNT```
```EVENT_MONTH_COUNT```
```BADGE_i```
| | with TTL set accordingly | -| Contribution | Acquired trophy points | ```CONTRIB_TROPHY:categ``` | zset | org | -| Contribution | Last org to get a trophy or badge | ```CONTRIB_LAST_AWARDS:date``` | zset | org | -| Users | Use to consider only one org per hour | ```LOGIN_TIMESTAMPSET:date_hour``` | set | org (TTL = 1 hour) | -| Users | Use to get when users connect to MISP | ```LOGIN_TIMESTAMP:date``` | set | timestamp | -| Users | When an org connects to MISP | ```LOGIN_ORG:date``` | zset | org | -| Trendings | Popularity of type | ```TRENDINGS_type:date``` | zset | type_name | +| contributor_helper | Acquired trophy points | ```CONTRIB_TROPHY:categ``` | zset | org | +| contributor_helper | Last org to get a trophy or badge | ```CONTRIB_LAST_AWARDS:date``` | zset | org | + +## Users + +| Module | Feature | Key name | Key type | Key content | +|---------------------|---------------------------------------|------------------------------------|----------|--------------------------| +| users_helper | Use to consider only one org per hour | ```LOGIN_TIMESTAMPSET:date_hour``` | set | org (TTL = 1 hour) | +| users_helper | Use to get when users connect to MISP | ```LOGIN_TIMESTAMP:date``` | set | timestamp | +| users_helper | When an org connects to MISP | ```LOGIN_ORG:date``` | zset | org | + +## Trendings +| Module | Feature | Key name | Key type | Key content | +|---------------------|---------------------------------------|------------------------------------|----------|--------------------------| +| trendings_helper | Popularity of type | ```TRENDINGS_type:date``` | zset | type_name | | | ```type``` is one of: | ```EVENTS```
```CATEGS```
```TAGS```
```DISC```
| | | -| Trendings | Popularity of type | ```TRENDINGS_SIGHT_type:date``` | string | integer | +| trendings_helper | Popularity of type | ```TRENDINGS_SIGHT_type:date``` | string | integer | | | ```type``` is one of: | ```sightings```
```false_positive```| | || diff --git a/doc/message_passing.png b/doc/message_passing.png index 7b6181b..722adee 100644 Binary files a/doc/message_passing.png and b/doc/message_passing.png differ