Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

no benchmark example? and incorrect doc instructions #5398

Closed
1 task done
swelborn opened this issue Nov 13, 2024 · 1 comment · Fixed by eProsima/Fast-DDS-docs#961 · May be fixed by #5460
Closed
1 task done

no benchmark example? and incorrect doc instructions #5398

swelborn opened this issue Nov 13, 2024 · 1 comment · Fixed by eProsima/Fast-DDS-docs#961 · May be fixed by #5460
Labels
in progress Issue or PR which is being reviewed

Comments

@swelborn
Copy link

swelborn commented Nov 13, 2024

Is there an already existing issue for this?

  • I have searched the existing issues

Expected behavior

Expect that the docker instructions in this page are accurate:

https://fast-dds.docs.eprosima.com/en/v3.1.0/docker/fastdds_suite/fast_dds_suite.html#benchmark-example

Current behavior

This is the examples directory in v3.1.0 without the "suite" (ubuntu-fastdds:v3.1.0 image name):

root@login07:/usr/local/eprosima/fastdds/share/fastdds/examples/cpp# ls -la
total 52
drwxr-xr-x 15 root root  336 Oct 15 11:20 .
drwxr-xr-x  3 root root   25 Oct 15 11:20 ..
drwxr-xr-x  3 root root 4096 Oct 15 11:20 configuration
drwxr-xr-x  3 root root 4096 Oct 15 11:20 content_filter
drwxr-xr-x  3 root root 4096 Oct 15 11:20 custom_payload_pool
drwxr-xr-x  3 root root 4096 Oct 15 11:20 delivery_mechanisms
drwxr-xr-x  3 root root 4096 Oct 15 11:20 discovery_server
drwxr-xr-x  3 root root 4096 Oct 15 11:20 flow_control
drwxr-xr-x  3 root root 4096 Oct 15 11:20 hello_world
drwxr-xr-x  4 root root 4096 Oct 15 11:20 request_reply
drwxr-xr-x  3 root root 4096 Oct 15 11:20 rtps
drwxr-xr-x  4 root root 4096 Oct 15 11:20 security
drwxr-xr-x  3 root root 4096 Oct 15 11:20 static_edp_discovery
drwxr-xr-x  3 root root 4096 Oct 15 11:20 topic_instances
drwxr-xr-x  3 root root 4096 Oct 15 11:20 xtypes

This is with the suite:

root@login07:~# goToExamples
root@login07:/usr/local/eprosima/fastdds/share/fastdds/examples/cpp# ls
configuration   custom_payload_pool  discovery_server  hello_world    rtps      static_edp_discovery  xtypes
content_filter  delivery_mechanisms  flow_control      request_reply  security  topic_instances

This is what happens with the 3.0.1 suite (ubuntu-fastdds-suite:v3.0.1):

root@login07:~# goToExamples
bash: cd: /usr/local/eprosima/share/fastdds/examples/cpp: No such file or directory

Steps to reproduce

Download image, run

Fast DDS version/commit

v3.1.0, v3.0.1

Platform/Architecture

Ubuntu Focal 20.04 amd64

Transport layer

Default configuration, UDPv4 & SHM

Additional context

Hello world example works, but just can't find benchmark.

XML configuration file

No response

Relevant log output

No response

Network traffic capture

No response

@swelborn swelborn added the triage Issue pending classification label Nov 13, 2024
@rsanchez15
Copy link
Contributor

Hi @swelborn

When migrating to Fast DDS v3, we refactored the examples to make them clearer and better show the functionalities that explain each one.

In addition, this refactoring allows the examples to be tested in an automated way.

Today, we are still in the process of covering all the old examples, Benchmarking one of the ones that were left out of the first refactoring batch.

For the moment, we will update the documentation so that it shows what we have right now while we work on the refactoring of the Benchmarking example.

@rsanchez15 rsanchez15 added in progress Issue or PR which is being reviewed and removed triage Issue pending classification labels Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in progress Issue or PR which is being reviewed
Projects
None yet
2 participants