Skip to content

Commit

Permalink
Merge pull request #16 from redBorder/feature/#17099_chapters_4.6_to_…
Browse files Browse the repository at this point in the history
…4.10

Feature/#17099 Migrate C6 chapter 4.6 to 4.10 of manual to NG docs website
  • Loading branch information
ljblancoredborder authored Apr 29, 2024
2 parents 1af6263 + 8692cd3 commit 61f8805
Show file tree
Hide file tree
Showing 6 changed files with 177 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/index.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Las secciones de documentación son las siguientes:

Queremos hacer que nuestra documentación se accesible para todos. De momento, nuestra documentación se encuentra disponible en español e inglés. Futuras versiones podrían llegar a incluir traducciones a otros idiomas

!!! info "Tenga en cuenta..."
!!! info "Ten en cuenta..."

Debido a una limitación inherente a MkDocs, puede que algunas funciones de la plataforma no estén disponibles en todos los idiomas.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Es posible también, configurar RedBorder para utilizar el servicio de Amazon RD

Dependiendo de cómo sea la instalación de RedBorder que se quiera realizar, se puede indicar a la plataforma qué es lo que se debe ejecutar en el nodo en instalación. El caso más común será la instalación de un único manager en la red, para esto se debe elegir el modo `full`, esto indicará a la plataforma que debe ejecutar todos los servicios en el máquina en cuestión.

!!! tip "Ten en cuenta..."
!!! info "Ten en cuenta..."
Si se instalará un cluster de managers, se debe elegir que uno de los nodos trabaje en modo `core` mientras que los otros nodos deben operar en el modo `custom` y seleccionar qué servicios mantendrán.

![Configurar modo de manager](images/ch02_img009.png)
Expand Down
94 changes: 87 additions & 7 deletions docs/manager/redborder_basics/ch4_2_modules_menu_options.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,15 @@ Permiten a los usuarios aislar una porción de la información para detallarla.
- *Crear una alarma.*
- *Crear un widget.*

Para más información sobre los filtros de eventos, puede consultar el artículo [Filtrado de eventos](/manager/more_in_detail/ch4_3_filtering_events)

![Filtros](images/ch04_img012.png)

Filtros

### Vistas

Ofrece diferentes opciones para mostrar la información.
Ofrece diferentes opciones para mostrar la información. Para más información, puede consultar el artículo [Vistas, varias opciones para visualizar datos](/manager/more_in_detail/ch4_5_views)

- *Raw*: eventos en bruto.
- *Tops*: muestra la suma total de datos de diferentes eventos para mostrarlos como uno solo.
Expand All @@ -42,6 +44,34 @@ Vistas

Hay diferentes valores o unidades de medida en los que los datos pueden ser mostrados. Por ejemplo, flows por segundo (flows/s) o bytes por segundo (bps). Tenga en cuenta que cada módulo tiene sus propias opciones de agregación.

Si desea ver las agregaciones disponibles, despliegue esta pestaña:

??? info "Agregaciones disponibles"

| Agregación | Descripción |
| ------------------ | -------------------------------------- |
| bps | Número de bits por segundo |
| bytes | Número total de bytes transferidos |
| packets | Número total de paquetes enviados a través de la red |
| packets/s | Número total de paquetes por segundo enviados a través de la red |
| flows | Número de flujos exportados |
| flows/s | Número de flujos exportados por segundo |
| client | Número de direcciones MAC únicas detectadas por la sonda de red |
| quality | Porcentaje de la fuerza de señal de la red según lo reportado por el controlador inalámbrico y basado en RSSI y número de clientes |
| risk | Porcentaje que representa cuán malicioso es su tráfico basado en sistemas de reputación |
| wireless stations | Número de estaciones inalámbricas reportadas por el controlador inalámbrico |
| clients/station | Número de clientes que tiene cada estación inalámbrica |
| bps/client | Promedio de uso de red que produce cada cliente |
| bytes/client | Promedio de bytes que envía cada cliente |
| flows/client | Número de flujos exportados por la red dividido por el número de clientes |
| fps/client | Número de flujos por segundo exportados por la sonda de red dividido por el número de clientes |
| bytes/station | Promedio de bytes que envía cada estación inalámbrica |
| bps/station | Promedio de uso de red que produce cada estación inalámbrica |

!!! tip "Se recomienda..."

Optimice su métrica combinando diferentes tipos de opciones de granularidad de agregación (períodos de tiempo) que están disponibles.

![Agregación](images/ch04_img014.png)

Agregación
Expand All @@ -50,43 +80,69 @@ Agregación

Indica el grado de detalle temporal que puede mostrar la información. El mínimo valor para la granularidad es un minuto.

Las opciones de granularidad varían según el rango de tiempo que se muestra (1h., 2h., La semana pasada, el mes pasado, etc.). Con esta vista, el usuario puede analizar el tráfico de red en tiempo real.

De acuerdo con el período de tiempo seleccionado, el usuario puede conocer los detalles del tráfico en, por ejemplo, un lapso de dos minutos.

![Granularidad](images/ch04_img015.png)

Granularidad

### Gráfico

Muestra los diferentes tipos de gráficos entre los que podemos mostrar los datos. Los tipos de gráficos disponibles varían dependiendo de la vista seleccionada. Son los siguientes:
Muestra los diferentes tipos de gráficos entre los que se pueden mostrar los datos. Los tipos de gráficos disponibles varían dependiendo de la vista seleccionada. Esta opción no aparece, por ejemplo, al aplicar la vista de mapa de los datos, ya que los datos se representan en dicho mapa.

Estas son las posibilidades gráficas de la plataforma Redborder para vistas:

**Área**: gráfico que proporciona una superposición de los datos a un grupo de elementos que pertenecen al atributo seleccionado, haciendo que el tráfico total sea la suma del tráfico por atributo.

![Tipo de gráfico: Área](images/ch04_img016.png)

Tipo de gráfico: Área

Si se desea mostrar un solo elemento gráfico, simplemente haga clic sobre su gráfica dibujada para aislarlo.

**Líneas**: gráfico que proporciona una superposición de los datos a un grupo de elementos que pertenecen al atributo seleccionado; en este caso, el área no se muestra pero el gráfico está representado por una línea.

![Tipo de gráfico: Líneas](images/ch04_img017.png)

Tipo de gráfico: Líneas

**Barras**: proporciona una superposición de datos a un grupo de elementos que pertenecen al atributo seleccionado, siendo el total, la suma de valores de cada uno de esos elementos. En este caso, los datos se representan mediante barras.

![Tipo de gráfico: Barras](images/ch04_img018.png)

Tipo de gráfico: Barras

**Barras apiladas**: también llamado o **Barras acumuladas**, proporciona en el mismo gráfico los datos obtenidos para cada uno de los elementos incluidos en el atributo seleccionado, para que pueda ver los resultados de IP independiente, sensor, etc., representados en barras.

![Tipo de gráfico: SBarras](images/ch04_img019.png)

Tipo de gráfico: Barras apiladas

**Acumulado**: muestra comparativamente en el mismo gráfico los datos para cada uno de los atributos seleccionados.

![Tipo de gráfico: Acumulado](images/ch04_img020.png)

Tipo de gráfico: Acumulado

**Flujos**: gráfico solo disponible en la vista Raw. Muestra el flujo del tráfico por sensor.

![Tipo de gráfico: Flujos](images/ch06_img001.png)

Tipo de gráfico: Flujos

### Opciones

En esta sección, el usuario puede realizar varias acciones para administrar los datos que se muestran. Las opciones varían según la vista seleccionada.

- *Mostrar total filtrado/Ocultar total filtrado*: muestra u oculta el gráfico considerando los filtros seleccionados.
- *Exportar a CSV*: proporciona la opción de exportar a CSV un informe de cualquier campo seleccionando el límite del evento.
- *Máquina del tiempo*: permite cambiar la fecha/hora de la máquina para poder ver toda la información y los eventos que han transcurrido en ese período de tiempo.
- *Mostrar total /Ocultar total*: al seleccionar esta opción, se muestra en el gráfico el valor de todo el tráfico diferenciado recibido o emitido por cada uno de los atributos que se pueden consultar. Cuando esta opción está activa, aparece la lista de opciones "Ocultar total". Disponible en la vista superior y única.
- *Exportar a CSV*: proporciona la opción de exportar a CSV que incluye los datos que corresponden al atributo seleccionado, puede establecer un límite de filas para incluir en el archivo. Disponible solo para las **vistas Tops y Único**.
- *Máquina del tiempo*: devuelve la máquina a un estado anterior. Al seleccionar esta opción, el usuario puede ver los datos como si los estuviera viendo en el último día y hora especificados. Disponible para todas las vistas excepto para Raw.
- *Ordenar agregaciones*: permite cambiar el orden de las agregaciones que se muestran en el módulo.
- *Guardar pestañas como predeterminadas*: al seleccionar esta opción, se puede modificar el diseño de pestañas predeterminado.
- *Ordenar columnas*: **disponible para la vista Raw**. permite cambiar el orden de las columnas que se muestran en el módulo.
- *Guardar pestañas/columnas como predeterminadas*: al seleccionar esta opción, las pestañas abiertas actualmente se guardarán como las pestañas predeterminadas.
- *Activar recarga*: **disponible para la vista Raw**. Activa la cuenta regresiva para la recarga de datos; en la izquierda de la barra de sección aparece una cuenta regresiva que indica el tiempo para volver a cargar. En cualquier momento, se puede detener esto seleccionando *Detener la recarga*.

![Opciones](images/ch04_img021.png)

Expand All @@ -96,7 +152,31 @@ Opciones

Los eventos recibidos por el Manager consisten en un par "columna: valor". Los valores dados en cada columna pueden entenderse como datos específicos del evento que son los que realmente proporcionan información. Estos son los llamados "atributos".

Los atributos pueden ser mostrados de diferentes maneras: como pestañas o como columnas (Añadir Pestañas/Columnas) dependiendo de la vista en la que se encuentre.
Estos atributos nos ayudan a llevar a cabo un análisis integral y personalizado para cada uno de los elementos involucrados en el flujo del tráfico de red de nuestra organización. Estos se organizan en pestañas o columnas a la vista que estamos consultando. Las opciones que se muestran son comunes para todas las vistas, excepto para el caso de Comparar (ofrece solo comparabilidad por semanas o meses) y Mapas, en cuyo caso esta sección no se muestra.

Si desea ver las categorías de atributos disponibles, despliegue esta pestaña:

??? info "Categorías de atributos disponibles"

=== "Categorías generales"

- Aplicación
- Datos de cliente
- Lista negra
- Enlace de datos
- Flujo
- Interfaz
- Localización
- Red
- Transporte
- UUIDs

=== "Categorías de Malware"

- Email
- Archivo
- Malware
- Red

![Atributos](images/ch04_img022.png)

Expand Down
96 changes: 88 additions & 8 deletions docs/manager/redborder_basics/ch4_2_modules_menu_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,15 @@ Allow users to isolate a portion of the information for detailed inspection. In
- *Create an alarm.*
- *Create a widget.*

For more information about event filters, you can refer to the article [Event Filtering](/manager/more_in_detail/ch4_3_filtering_events)

![Filters](images/ch04_img012.png)

Filters

### Views

Offers different options for displaying information.
Offers different options for displaying information. For more information, you can refer to the article [Views, multiple options for visualizing data](/manager/more_in_detail/ch4_5_views)

- *Raw*: Raw events.
- *Tops*: Shows the total sum of data from different events to display them as one.
Expand All @@ -44,6 +46,34 @@ Views

There are different values or units of measure in which the data can be displayed. For example, flows per second (flows/s) or bytes per second (bps). Note that each module has its own aggregation options.

If you want to see the available aggregations, expand this tab:

??? info "Available Aggregations"

| Aggregation | Description |
| ------------------ | -------------------------------------- |
| bps | Number of bits per second |
| bytes | Total number of bytes transferred |
| packets | Total number of packets sent across the network |
| packets/s | Total number of packets per second sent across the network |
| flows | Number of exported flows |
| flows/s | Number of exported flows per second |
| client | Number of unique MAC addresses detected by the network probe |
| quality | Percentage of network signal strength as reported by the wireless controller and based on RSSI and number of clients |
| risk | Percentage representing how malicious your traffic is based on reputation systems |
| wireless stations | Number of wireless stations reported by the wireless controller |
| clients/station | Number of clients each wireless station has |
| bps/client | Average network usage per client |
| bytes/client | Average bytes sent per client |
| flows/client | Number of flows exported by the network divided by the number of clients |
| fps/client | Number of flows per second exported by the network probe divided by the number of clients |
| bytes/station | Average bytes sent per wireless station |
| bps/station | Average network usage per wireless station |

!!! tip "Recommendation..."

Optimize your metric by combining different types of aggregation granularity options (time periods) that are available.

![Aggregation](images/ch04_img014.png)

Aggregation
Expand All @@ -52,43 +82,69 @@ Aggregation

Indicates the degree of temporal detail that can be shown in the information. The minimum value for granularity is one minute.

Granularity options vary depending on the time range displayed (1h, 2h, Last week, Last month, etc.). With this view, the user can analyze network traffic in real-time.

Depending on the selected time period, the user can understand traffic details, for example, over a two-minute interval.

![Granularity](images/ch04_img015.png)

Granularity

### Chart

Displays the different types of charts among which we can show the data. The available chart types vary depending on the selected view. They are as follows:
Displays the different types of graphs among which the data can be shown. The available graph types vary depending on the selected view. This option does not appear, for example, when applying the map view of the data, as the data is represented on that map.

These are the graphical possibilities of the Redborder platform for views:

**Area**: graph that overlays the data on a group of elements belonging to the selected attribute, making the total traffic the sum of the traffic per attribute.

![Chart Type: Area](images/ch04_img016.png)

Chart Type: Area

To display a single graphical element, simply click on its drawn graph to isolate it.

**Lines**: graph that overlays the data on a group of elements belonging to the selected attribute; in this case, the area is not shown but the graph is represented by a line.

![Chart Type: Lines](images/ch04_img017.png)

Chart Type: Lines

**Bars**: overlays data on a group of elements belonging to the selected attribute, with the total being the sum of values for each of those elements. In this case, the data is represented by bars.

![Chart Type: Bars](images/ch04_img018.png)

Chart Type: Bars

**Stacked Bars**: provides in the same graph the data obtained for each of the elements included in the selected attribute, so you can see the results of independent IP, sensor, etc., represented in bars.

![Chart Type: Stacked Bars](images/ch04_img019.png)

Chart Type: Stacked Bars

**Accumulated**: comparatively shows the data for each of the selected attributes in the same graph.

![Chart Type: Accumulated](images/ch04_img020.png)

Chart Type: Accumulated

**Flows**: graph only available in Raw view. Shows traffic flow by sensor.

![Graph Type: Flows](images/ch06_img001.png)

Graph Type: Flows

### Options

In this section, the user can perform various actions to manage the data being displayed. The options vary depending on the selected view.

- *Show filtered total/Hide filtered total*: shows or hides the chart considering the selected filters.
- *Export to CSV*: Provides the option to export a CSV report of any selected field by selecting the event limit.
- *Time Machine*: Allows changing the date/time of the machine to view all information and events that have occurred in that time period.
- *Sort aggregations*: Allows changing the order of the aggregations displayed in the module.
- *Save tabs as default*: By selecting this option, the default tabs layout can be modified.
- *Show total/Hide total*: when selecting this option, the value of all differentiated traffic received or transmitted by each of the attributes that can be queried is displayed on the graph. When this option is active, the list of "Hide total" options appears. Available in the upper and unique view.
- *Export to CSV*: provides the option to export to CSV including the data corresponding to the selected attribute, you can set a row limit to include in the file. Only available for **Tops and Unique views**.
- *Time machine*: returns the machine to a previous state. By selecting this option, the user can see the data as if they were viewing it on the last specified day and time. Available for all views except Raw.
- *Sort aggregations*: allows changing the order of the aggregations displayed in the module.
- *Sort columns*: **available for Raw view**. Allows changing the order of the columns displayed in the module.
- *Save tabs/columns as default*: by selecting this option, the currently open tabs will be saved as the default tabs.
- *Start Reloading*: **available for Raw view**. Activates the countdown for data reload; on the left of the section bar, a countdown appears indicating the time to reload. At any time, this can be stopped by selecting *Stop Reloading*.

![Options](images/ch04_img021.png)

Expand All @@ -98,7 +154,31 @@ Options

Events received by the Manager consist of a "column: value" pair. The values given in each column can be understood as specific event data that actually provide information. These are called "attributes".

Attributes can be displayed in different ways: as tabs or as columns (Add Tabs/Columns) depending on the view you are in.
These attributes help us carry out a comprehensive and customized analysis for each of the elements involved in the flow of network traffic in our organization. These are organized into tabs or columns in the view we are consulting. The options shown are common for all views, except for the Compare case (offers only comparability by weeks or months) and Maps, in which case this section is not shown.

If you want to see the available attribute categories, expand this tab:

??? info "Available Attribute Categories"

=== "General Categories"

- Application
- Client Data
- Blacklist
- Data Link
- Flow
- Interface
- Location
- Network
- Transport
- UUIDs

=== "Malware Categories"

- Email
- File
- Malware
- Network

![Attributes](images/ch04_img022.png)

Expand Down
Binary file modified docs/manager/redborder_basics/images/ch04_img022.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 61f8805

Please sign in to comment.