SharedArray is an array-like object that shares the underlying memory between VUs. Its constructor takes a name for the SharedArray and a function which needs to return an array object itself. The function will be executed only once and its result will then be saved in memory once and copies of the elements will be given when requested. The name is needed as VUs are completely separate JS VMs and k6 needs some way to identify the SharedArrays that it needs to return.
This does mean that you can have multiple such ones and even only load some of them for given VUs, although that is unlikely to have any performance benefit.
Everything about SharedArray is read-only once it is constructed, so it is not possible to communicate between VUs using it.
Supported operations include:
- getting the number of elements with length
- getting an element by its index using the normal syntax array[index]
- using for-of loops
Which means that for the most part if you currently have an array data structure that you want to take less memory you can just wrap it in SharedArray and it should work for most cases.
As the SharedArray is keeping the data marshalled as JSON and unmarshals elements when requested it does take additional time to unmarshal JSONs and generate objects that then need to be garbage collected.
This in general should be unnoticeable compared to whatever you are doing with the data, but might mean that for small sets of data it is better to not use SharedArray, although your mileage may vary.
As an example the following script:
Which was ran with v0.30.0 and 100 VUs started to even out the CPU usage around 10k elements, but also was using 1/3 of the memory. At 100k SharedArray was the clear winner, while for lower numbers it is possible that not using it will help with performance.
|data lines||shared||wall time||CPU %||mem usage||http requests|
The CPU/memory data comes from using /usr/bin/time and the raw data can be found here.
These numbers are purely illustrative as the performance can be affected by any additional processing of the element retrieved from the SharedArray, or if an output is in use, or it gets multiple elements, etc. While SharedArray has some CPU usage it might turn out that it will be negligible in a given situation with just 10 elements or more problematic than the memory usage for a 100k elements. So if in doubt you should probably run some benchmarks and decide which tradeoffs are more important for your use case.