Skip to content

Commit

Permalink
Rebranding: from ActivePivot to Atoti Server in doc (#116)
Browse files Browse the repository at this point in the history
  • Loading branch information
CamilleBlanco authored Aug 25, 2023
1 parent 4d50f40 commit c9a366f
Show file tree
Hide file tree
Showing 10 changed files with 36 additions and 34 deletions.
4 changes: 2 additions & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ workflows:
"5.9.11",
"5.9.12",
"5.9.13",
# Early releases of the 5.10 sandbox have a dependency on a now removed ActiveUI snapshot : activeui:jar:5.0.0-beta-20210224125715-19abcee
# Early releases of the 5.10 sandbox have a dependency on a now removed Atoti UI snapshot : activeui:jar:5.0.0-beta-20210224125715-19abcee
# "5.10.0",
# "5.10.1",
# "5.10.2",
Expand All @@ -151,7 +151,7 @@ workflows:
"5.10.11",
"5.10.12",
"5.10.13",
# Early releases of the 5.11 sandbox have a dependency on a now removed ActiveUI snapshot : activeui:jar:5.0.4-20211117104705-da07c29
# Early releases of the 5.11 sandbox have a dependency on a now removed Atoti UI snapshot : activeui:jar:5.0.4-20211117104705-da07c29
# "5.11.0",
"5.11.1",
"5.11.2",
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Memory Analysis Cube

The Memory Analysis Cube (MAC) is an ActivePivot project that aims to provide
The Atoti Memory Analysis Cube (MAC) is an Atoti project that aims to provide
the necessary tools to explore and analyze the data consumption from any other
ActivePivot application, starting from ActivePivot 5.8 onward.
Atoti application, starting from Atoti Server 5.8 onward.

The project is built as a standalone Spring Boot jar file with an embedded
ActiveUI application available on `localhost:9092` by default.
Atoti UI application available on `localhost:9092` by default.

**This version is compatible with exports from ActivePivot 5.8+ servers.**
**This version is compatible with exports from Atoti Server 5.8+ servers.**

The MAC server uses the latest released versions of ActivePivot and ActiveUI by default,
The MAC server uses the latest released versions of Atoti Server and Atoti UI by default,
but the dependency versions can be changed in the project's POM.

## Main Features
Expand All @@ -18,7 +18,7 @@ but the dependency versions can be changed in the project's POM.
* Store/Field-related memory footprint
* Cube-related memory footprint
* Overview of structure-related memory footprint
* Loading and comparing several ActivePivot applications' exported memory
* Loading and comparing several Atoti applications' exported memory
dump files

## Building & launching the application
Expand All @@ -29,8 +29,8 @@ but the dependency versions can be changed in the project's POM.
The requirements for building the MAC application are the following :
- Maven 3.0 +
- Java 11 +
- ActivePivot artifacts
- ActiveUI artifacts
- Atoti Server artifacts
- Atoti UI artifacts

The SpringBoot JAR of the application can be built by running the following command line:

Expand All @@ -43,7 +43,7 @@ mvn clean install -DskipTests=true
The requirements for launching the MAC application are the following :
- Java 11+
- The built MAC .jar file
- A valid ActivePivot license
- A valid Atoti Server license

Once the JAR file built on the `./target directory`, the MAC server can be launched by the following command line:

Expand All @@ -53,7 +53,7 @@ java -jar [path to the MAC .jar file]

## Prepare your Application for Analysis

ActivePivot 5.8+ applications come with a number of ways to export their memory
Atoti Server 5.8+ applications come with a number of ways to export their memory
usage in the form of memory report files, that can then be imported and analyzed
using MAC.

Expand All @@ -71,7 +71,7 @@ important to get familiar with its [data model](docs/data_model.md).

## Bookmarks

MAC comes with a number of predefined ActiveUI bookmarks that each offer some insights to
MAC comes with a number of predefined Atoti UI bookmarks that each offer some insights to
various aspects of the monitored application.

* [Overview](docs/bookmarks/overview.md)
Expand Down
10 changes: 5 additions & 5 deletions docs/data_model.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
MAC is composed of one cube. Its base store is based on Chunks, which atomically
contain all the off-heap data used by ActivePivot.
contain all the off-heap data used by Atoti Server.

Chunks are attributed to various higher level structures, that are represented
by MAC's hierarchies and dimensions and can be queried upon.
Expand Down Expand Up @@ -41,8 +41,8 @@ Since they are application-wide, they have the same value for all locations.
```
> This differs slightly from `DirectMemory.Ratio`, as this includes, along with
> the direct memory consumed by the chunks:
> * ActivePivot's SLAB memory allocator cache
> * direct memory used by libraries other than ActivePivot
> * Atoti Server's SLAB memory allocator cache
> * direct memory used by libraries other than Atoti Server
* `MaxDirectMemory.Ratio`: the total ratio of off-heap memory consumed by the chunks
relative to the total application committed direct memory
<!--
Expand All @@ -54,7 +54,7 @@ Since they are application-wide, they have the same value for all locations.
MaxDirectMemory.Ratio := DirectMemory.SUM / MaxDirectMemory
```
* `HeapMemory.SUM`: an estimate of the on-heap size of the chunks
> **Warning**: do **NOT** assume total on-heap memory usage by ActivePivot
> **Warning**: do **NOT** assume total on-heap memory usage by Atoti Server
> based on this measure.
>
> These estimates rely on manual calculations from within the application that
Expand Down Expand Up @@ -136,7 +136,7 @@ Since they are application-wide, they have the same value for all locations.
Chunks are always held by a higher-level structure, which is called the *owner*
in MAC.
The different owners of an ActivePivot application are stores of the datastore
The different owners of an Atoti application are stores of the Datastore
and the different cubes of the application.
### Owner
Expand Down
10 changes: 5 additions & 5 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Memory Analysis Cube

The Memory Analysis Cube (MAC) is an ActivePivot project that aims to provide
The Memory Analysis Cube (MAC) is an Atoti project that aims to provide
the necessary tools to explore and analyze the data consumption from any other
ActivePivot application, starting from ActivePivot 5.8 onward.
Atoti application, starting from Atoti Server 5.8 onward.

The project is built as a standalone Spring Boot jar file with an embedded
ActiveUI application available on `localhost:9092` by default.
Atoti UI application available on `localhost:9092` by default.

## Main Features

* Off Heap memory usage monitoring
* Store/Field-related memory footprint
* Cube-related memory footprint
* Overview of structure-related memory footprint
* Loading and comparing several ActivePivot applications' exported memory
* Loading and comparing several Atoti applications' exported memory
dump files

## Prepare your Application for Analysis

ActivePivot 5.8+ applications come with a number of ways to export their memory
Applications built using Atoti Server 5.8+ come with a number of ways to export their memory
usage in the form of memory report files, that can then be imported and analyzed
using MAC.

Expand Down
4 changes: 2 additions & 2 deletions docs/setting_up/exporting.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Exporting Data from an ActivePivot Application
# Exporting Data from an Atoti Application

The exporting of an ActivePivot application is done through an
The exporting of an Atoti application is done through an
`IMemoryAnalysisService`.

This service can be instantiated
Expand Down
2 changes: 1 addition & 1 deletion docs/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Some settings can be configured in the `application.yml` file in MAC's
*resources* folder.

The usual ActivePivot spring application properties can be set in this file. A few
The usual Atoti Spring application properties can be set in this file. A few
MAC specific settings can also be set:

* `statistic.folder`: the path to the statistics folder, from which MAC extracts
Expand Down
4 changes: 2 additions & 2 deletions scripts/mac_export_load.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#! /bin/bash

# Script loading the result of an ActivePivot SandBox Memory Analysis Service's Export into a mac project
# Script loading the result of an Atoti Server SandBox Memory Analysis Service's Export into a mac project

# 1- Build the mac project as a sandbox jar
# 2- Load data from the input folder
Expand All @@ -13,7 +13,7 @@
# Java Development Kit 11+ (JRE is not enough as we use the jps command)
# Maven
# ActiveViam artifacts access
# Valid ActivePivot License
# Valid Atoti Server License
# cURL
# jq

Expand Down
8 changes: 4 additions & 4 deletions scripts/sandbox_export_generator.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#! /bin/bash

# Script Exporting the Memory Analysis Service output of a released ActivePivot sandbox
# Script Exporting the Memory Analysis Service output of a released Atoti Server sandbox

# 1- Executes a maven goal that builds a customized (no real time) Sandbox springboot jar for a given version of Activepivot
# 1- Executes a maven goal that builds a customized (no real time) Sandbox springboot jar for a given version of Atoti Server
# 2- Run the sandbox
# 3- Generate the memory statistics file for the Sandbox

Expand All @@ -12,11 +12,11 @@
# Java Development Kit 11+ (JRE is not enough as we use the jps command)
# Maven
# ActiveViam artifacts access
# Valid ActivePivot License
# Valid Atoti Server License
# cURL

# INPUT :
# - 1 String : ActivePivot version used by the sandbox app
# - 1 String : Atoti Server version used by the sandbox app
# - 2 String : URL of the Artifactory Sandbox repository
# - 3 Optional String : Path to the maven settings file, this file is expected to grant read access to ActiveViam artifacs

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@
import org.springframework.context.annotation.Configuration;

/**
* Spring configuration for ActiveUI web application.
* Spring configuration for Atoti UI web application.
*
* @author ActiveViam
*/
@Configuration
public class ActiveUiResourceServerConfig extends ASpringResourceServerConfig {

/** The namespace of the ActiveUI web application. */
/** The namespace of the Atoti UI web application. */
public static final String NAMESPACE = "ui";

/** Constructor. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;

public class TestDistributedCubeEpochs extends ATestMemoryStatistic {
Expand Down Expand Up @@ -137,6 +138,7 @@ private void initializeMonitoringApplication(final IMemoryStatistic data) {
monitoringApp.getDatabase(), List.of(data), "testDistributedCubeEpochs");
}

@Disabled("See https://activeviam.atlassian.net/browse/PIVOT-7689")
@Test
public void testExpectedViewEpochs() {
final Set<EpochView> viewEpochIds = retrieveViewEpochIds();
Expand Down

0 comments on commit c9a366f

Please sign in to comment.