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

To fix the issue: show_techsupport & saidump errors during testbed testing by replacing redis-rdb-tool with rdb-cli #1391

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

JunhongMao
Copy link
Contributor

@JunhongMao JunhongMao commented Jun 11, 2024

Why I did it

Fix issue: #1387
The latest redis-rdb-tools-0.1.15 doesn't support Redis 7.0. Redis 7.0 was released in 2020 and adopted by SONiC's latest version. So, this issue turned out.

https://github.com/sripathikrishnan/redis-rdb-tools

I.e., the rdb-tools is far behind the Redis 7.0. The librdb can perfectly fix this issue. Please see quote from https://github.com/redis/librdb.

Motivation behind this project
There is a genuine need by the Redis community for a versatile RDB file parser that can export data, perform data analysis, or merely extract raw data from RDB and RESTORE it against a live Redis server. However, available parsers have shortcomings in some aspects such as lack of long-term support, lagging far behind the latest Redis release, and usually not being optimized for memory, performance, or high-traffic streaming for production environments. Additionally, most of them are not written in C, which limits the reuse of Redis components and the potential to contribute back to Redis repo. To address these issues, it is worthwhile to develop a new parser with a modern architecture, that maybe can also challenge the current integrated RDB parser of Redis and even replace it in the future.

So, the below PRS are to replace rdbtools with librdb's tool rdb-cli.
sonic-net/sonic-buildimage#19268
#1391

The above PRs are based on the below PRs.
#1288
#1298
sonic-net/sonic-buildimage#16466
sonic-net/sonic-utilities#2972

How I did it

To use the Redis-db SAVE option to save the snapshot of DB each time and recover later, instead of looping through each entry in the table and saving it.

(1) Updated sonic-buildimage repo's platform/broadcom/docker-syncd-brcm-dnx/Dockerfile.j2, 
 install rdb-cli into the syncd containter.
(2) Updated sonic-sairedis repo's script file: files/scripts/saidump.sh, replace rdbtools with rdb-cli.
(3) Updated sonic-sairedis repo's saidump/saidump.cpp, to process the rdb-cli's ouput json file.

How to verify it

Method 1:
On T2 setup with more than 96K routes, execute CLI command -- generate_dump
No error should be shown

Method 2:
Go into syncd0 container.
admin@ixre-egl-board30:~$ docker exec -it syncd0 bash
Run below command, get saidump's sha1sum value.
root@ixre-egl-board30:/# saidump | sha1sum
1893097ecaeae72383432a54bfe4b285d05b23e5 -
Run below command, get saidump.sh's sha1sum value.
root@ixre-egl-board30:/# saidump.sh | sha1sum
1893097ecaeae72383432a54bfe4b285d05b23e5 -
The two sha1sum values should be the same and no error should be shown.
Method 3:
To run the testbed show_techsupport test case.

Which release branch to backport (provide reason below if selected)

  • 201811
  • 201911
  • 202006
  • 202012
  • 202106
  • 202111
  • 202205
  • 202211
  • 202305

Tested branch (Please provide the tested image version)

@JunhongMao JunhongMao changed the title To fix the issue: show_techsupport & saidump errors during testbed testing by replacing rdb-tool with rdb-cli To fix the issue: show_techsupport & saidump errors during testbed testing by replacing redis-rdb-tool with rdb-cli Jun 11, 2024
@JunhongMao
Copy link
Contributor Author

@mlok-nokia @kcudnik, please help to review, thanks.

@kcudnik
Copy link
Collaborator

kcudnik commented Jun 11, 2024

Please fix coverage

saidump/main.cpp Outdated Show resolved Hide resolved
saidump/saidump.h Outdated Show resolved Hide resolved
@JunhongMao JunhongMao force-pushed the master branch 3 times, most recently from 033e6a2 to 1b9d9d5 Compare June 13, 2024 02:54
saidump/Makefile.am Outdated Show resolved Hide resolved
@kcudnik
Copy link
Collaborator

kcudnik commented Jun 13, 2024

manyfiles have changes permissions from 644 to 755, please revert

saidump/saidump.cpp Outdated Show resolved Hide resolved
saidump/saidump.cpp Outdated Show resolved Hide resolved
saidump/saidump.h Outdated Show resolved Hide resolved
saidump/saidump.h Outdated Show resolved Hide resolved
saidump/saidump.h Outdated Show resolved Hide resolved
tests/checkwhitespace.sh Outdated Show resolved Hide resolved
@JunhongMao JunhongMao force-pushed the master branch 11 times, most recently from a759514 to d2fdd3f Compare June 17, 2024 21:26
kcudnik
kcudnik previously approved these changes Jul 27, 2024
Copy link
Collaborator

@kcudnik kcudnik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See rdb xomment

rdb/Makefile.am Outdated
bin_PROGRAMS = rdb-cli$(EXEEXT)
rdb_cli_SOURCES =

clone-repo:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this Rd tool needs to be installed here ? It seems like a bad design, it should be handled in Sonic build image repo in docket build script

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to Qiluo's review comments below. The Rdb-cli should only be installed into the syncd container. Sonic-sairedis's files, like saidump.sh, saidump are installed into the syncd container too. So it's a choice to install rdb-cli here.
sonic-net/sonic-buildimage#19268 (comment)

In the folder sonic-buildimage/dockers/ shown below, I could not find a script that can be used only to install rdb-cli into the syncd container. Could you give some suggestions? Thanks.

https://github.com/sonic-net/sonic-buildimage/tree/master/dockers

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kcudnik, @qiluo-msft , how about modifying the below file?
https://github.com/sonic-net/sonic-buildimage/blob/master/platform/broadcom/docker-syncd-brcm-dnx/Dockerfile.j2

Like adding below commands:

# Obtain librdb source codes
RUN git clone https://github.com/redis/librdb.git

# Build librdb
RUN cd ./librdb/;git submodule update --init --recursive;make -j4;cd ..

# Install rdb-cli
RUN install -p -D -m 0775 ./librdb/bin/rdb-cli /usr/bin/rdb-cli

# Clear librdb source codes
RUN rm -rf ./librdb

Copy link
Contributor Author

@JunhongMao JunhongMao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed. Please review it again.

@judyjoseph judyjoseph requested a review from kcudnik August 7, 2024 00:38
@rlhui
Copy link

rlhui commented Aug 14, 2024

@kcudnik would you like to sign off this?

@JunhongMao
Copy link
Contributor Author

Hello, @kcudnik. Reminder to review/approve.

@JunhongMao
Copy link
Contributor Author

JunhongMao commented Sep 16, 2024

Hello, @kcudnik. Please help to review and approve. It's been a long time since this PR was created.

@JunhongMao
Copy link
Contributor Author

Hello @deepak-singhal0408 , please help to review and approve. Thanks.

1 similar comment
@JunhongMao
Copy link
Contributor Author

Hello @deepak-singhal0408 , please help to review and approve. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

4 participants