chore: update docs for new alerts and reporting feature #13104

leocape · 2021-02-13T09:11:02Z

SUMMARY

Added docs for setting up and configuring the new alerts and reports in V.1.0

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TEST PLAN

Using the templates outlined in the doc, run these steps to get the new alerts and reporting feature working. After these steps are completed, you should now be able to create and test alerts and reports

Create a new directory and create the Dockerfile
Build the extended image using the Dockerfile
Create the docker-compose.yaml file in the same directory
Create a new sub directory called config
Create the superset_config.py file in the config sub directory
Run the image using docker-compose up in the same directory as the docker-compose.py file

ADDITIONAL INFORMATION

fix bullets fix redis depends on name in docker-compose template

Yann-J · 2021-02-14T16:35:27Z

FYI, I have just sent PR #13116 which would enable this on Kubernetes by (optionally) running Celery beat as a separate singleton pod.

The rest of the configuration can be injected using the existing chart mechanism:

Install webdrivers by overriding the worker's command (although doing this at startup time isn't great... the best would be to have them preinstalled in the image...)
Pass all the necessary superset_config.py overrides from values.yaml

step added: Upgrade the db step added: init step added: setup admin fix redis superset naming add . to docker build command

change postgres to internal so it persists on docker-compose down

vnourdin · 2021-02-15T14:05:25Z

docs/src/pages/docs/installation/email_reports.mdx

@@ -6,8 +6,309 @@ index: 10
 version: 1
 ---

-## Scheduling and Emailing Reports
+## Alerts and Reports


I'm not really comfy about putting the Alerts & Reports doc in a page named email-reports, as this doc concern alerts too, and not only emails but also Slack 🤷

I'd definitely agree, was really just for organisation so that in the menu there isn't 'Alerts and reporting' and then below it 'Scheduling and Emailing reports' which would be confusing imo, but if @srinify can help we could put it into its own section 'Alerts and Reporting', and then have the legacy reporting stuff remain at the bottom of this file?

I agree, renaming and keep the old approach at the end seems the best!

nytai · 2021-02-15T21:47:26Z

@leocape this is an excellent community effort in documenting a highly requested and very confusing feature set. I'm wondering how much of the config changes can be included in the default superset files (superset/config.py, Dockerfile, docker-compose.yml), so only minimal changes are required to enable this feature for testing. Documentation can then focus more on how to deploy this in prod-like environments (ie, not using docker-compose). Thoughts @dpgaspar? Are there any blockers (licensing) to adding the browser + webdriver to the Dockerfile?

nytai · 2021-02-16T00:34:44Z

I also opened #13143 which includes a new docker-compose file for non-dev use cases. I added a beat container which I realized was missing in the regular docker-compose workflow.

leocape · 2021-02-16T07:52:27Z

@leocape this is an excellent community effort in documenting a highly requested and very confusing feature set. I'm wondering how much of the config changes can be included in the default superset files (superset/config.py, Dockerfile, docker-compose.yml), so only minimal changes are required to enable this feature for testing. Documentation can then focus more on how to deploy this in prod-like environments (ie, not using docker-compose). Thoughts @dpgaspar? Are there any blockers (licensing) to adding the browser + webdriver to the Dockerfile?

Thanks @nytai with all the help from everyone on the Slack threads. Yes would be great to simplify this doc so that it focuses more/only on the feature related config. I could cut out the superfluous docker-compose and dockerfile if you can include the webdriver (and postgres?) into the default dockerfile?

leocape · 2021-02-16T07:55:31Z

#13116

Thanks @Yann-OAF I could link to it from this doc where I've placed the link placeholder?

Yann-J · 2021-02-14T17:32:49Z

docs/src/pages/docs/installation/email_reports.mdx

+    mv chromedriver /usr/bin && \
+    apt autoremove -yqq --purge && \
+    apt clean && \
+    rm -f google-chrome-stable_current_amd64.deb chromedriver_linux64.zip


I'm curious, would you have similar working instructions to install geckodriver? My attempts have been unsuccessful...

I couldn't get it working with geckodriver/firefox, no matter which version I tried, it wouldn't launch correctly when trying to take the screenshot... I suspect there is a missing config somewhere that is needed for it

It works with geckodriver too, we can adapt the doc to propose both approaches.

Yann-J · 2021-02-16T09:32:02Z

#13116

Thanks @Yann-OAF I could link to it from this doc where I've placed the link placeholder?

Yes, sounds good. These are probably too much to integrate to this doc, and won't be of interest to everyone (only k8s users) so linking is probably enough! I'm thinking I might start a dedicated doc on running in Kubernetes

dpgaspar

@leocape this is an excellent community effort in documenting a highly requested and very confusing feature set. I'm wondering how much of the config changes can be included in the default superset files (superset/config.py, Dockerfile, docker-compose.yml), so only minimal changes are required to enable this feature for testing. Documentation can then focus more on how to deploy this in prod-like environments (ie, not using docker-compose). Thoughts @dpgaspar? Are there any blockers (licensing) to adding the browser + webdriver to the Dockerfile?

I think it does not make sense to release a dockerfile with an webdriver + browser installed, and that's where we need to exclude all non compliant ASF packages/software. So IMO we should keep the docker file lean and clean, and add hooks so that it's easy to add additional packages or software (on this case)

btw, chrome driver license is 3-BSD, so it's "compatible" with ASF.

dpgaspar · 2021-02-16T11:20:12Z

docs/src/pages/docs/installation/email_reports.mdx

+RUN apt update
+RUN wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb && \
+    apt install -y --no-install-recommends ./google-chrome-stable_current_amd64.deb && \
+    wget https://chromedriver.storage.googleapis.com/88.0.4324.96/chromedriver_linux64.zip && \


These two versions will eventually differ

nytai · 2021-02-16T18:01:30Z

Ok, in that case we should keep the Dockerfile changes. I'm planning to add the beat container in #13143 so that should take care of some the docker-compose changes, though it will need to be updated to reference the new images.

shemExelate · 2021-02-16T18:45:44Z

docs/src/pages/docs/installation/email_reports.mdx

+4. Create a new sub directory called `config`
+5. Create the `superset_config.py` file in the `config` sub directory
+6. Run the image using `docker-compose up` in the same directory as the `docker-compose.py` file
+7. In a new terminal window, upgrade the DB by running `docker exec -it superset-1.0.1-extended superset db upgrade`


is there a better way to run

superset db upgrade superset init superset fab create-admin

as part of startup without entering the container?

i think the superset-init service in the docker-compose workflow should take care of this.

srinify · 2021-02-26T15:18:54Z

Hey @vnourdin @leocape I'm merging this as-is for now! The clean up process is quite involved, I like some things about the older commit and the latest commit and there's a lot of context to resolve. For now, it'd be nice to just have the info out there.

So I'm merging for now, and I'll do a second pass next week to clean up and organize better!

Kingflyinger · 2021-02-27T11:04:28Z

version: '3.6' services: redis-superset: image: redis:6.0.9-buster restart: on-failure
redis-superset should be replaced by redis,as well as superset_config.py.
or change the depends_on .

and after done all, what`s the account and password？ I tried admin/admin, wrong

* update docs for new alerts and reporting feature * fix punctuation * fix punctuation * fix punctuation fix bullets fix redis depends on name in docker-compose template * fix bullets * Add extra steps for getting v1.0.1 running step added: Upgrade the db step added: init step added: setup admin fix redis superset naming add . to docker build command * fix worker to use gevent instead of prefork change postgres to internal so it persists on docker-compose down * add comments to superset_config.py * ref: Re-organize a bit and make it easier to read * ref: rm useless level * docs: md changes + more details + kubernetes * docs: Rename to Alerts and Reports * docs: Link to Kubernetes doc * docs: details for docker-compose + minor md changes * docs: fix lists indent * docs: remove unused config * docs: Put detailed config and dockerfile before specific stuff * docs: clean Dockerfiles Co-authored-by: Valentin NOURDIN <[email protected]>

update docs for new alerts and reporting feature

c94fc95

pull-request-size bot added the size/L label Feb 13, 2021

leocape added 4 commits February 13, 2021 11:21

fix punctuation

2f8c937

fix punctuation

57a0343

fix punctuation

1a9e9e5

fix bullets fix redis depends on name in docker-compose template

fix bullets

4fa3b6c

amitmiran137 changed the title ~~update docs for new alerts and reporting feature~~ chore: update docs for new alerts and reporting feature Feb 13, 2021

Yann-J mentioned this pull request Feb 14, 2021

feat(helm): Helm template for Celery beat (for reporting and alerting) #13116

Merged

6 tasks

leocape added 3 commits February 15, 2021 09:13

Add extra steps for getting v1.0.1 running

6b56570

step added: Upgrade the db step added: init step added: setup admin fix redis superset naming add . to docker build command

fix worker to use gevent instead of prefork

a8c27b9

change postgres to internal so it persists on docker-compose down

add comments to superset_config.py

1f3674f

vnourdin reviewed Feb 15, 2021

View reviewed changes

Valentin NOURDIN added 2 commits February 15, 2021 16:35

ref: Re-organize a bit and make it easier to read

c778a2e

ref: rm useless level

b08a0f4

Yann-J reviewed Feb 16, 2021

View reviewed changes

dpgaspar reviewed Feb 16, 2021

View reviewed changes

shemExelate reviewed Feb 16, 2021

View reviewed changes

Valentin NOURDIN added 2 commits February 19, 2021 09:43

docs: md changes + more details + kubernetes

7afbc4c

docs: Rename to Alerts and Reports

196841e

pull-request-size bot added size/XL and removed size/L labels Feb 19, 2021

Valentin NOURDIN added 2 commits February 19, 2021 10:07

docs: Link to Kubernetes doc

9e0551d

docs: details for docker-compose + minor md changes

2758a2e

Valentin NOURDIN added 4 commits February 19, 2021 10:54

docs: fix lists indent

e859bbe

docs: remove unused config

f81da92

docs: Put detailed config and dockerfile before specific stuff

70bd92b

docs: clean Dockerfiles

2e24a57

srinify approved these changes Feb 26, 2021

View reviewed changes

srinify merged commit 1697e1e into apache:master Feb 26, 2021

octaviancorlade mentioned this pull request Apr 2, 2021

Improve documentation regarding Scheduling and Emailing Reports #11235

Closed

matrix-compute mentioned this pull request Dec 14, 2023

[Snyk] Fix for 15 vulnerabilities matrix-compute/superset#13

Open

mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 1.2.0 labels Mar 12, 2024

laxmanraparthi mentioned this pull request Mar 15, 2024

[Snyk] Fix for 22 vulnerabilities ShareChat/superset#156

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: update docs for new alerts and reporting feature #13104

chore: update docs for new alerts and reporting feature #13104

leocape commented Feb 13, 2021

Yann-J commented Feb 14, 2021

vnourdin Feb 15, 2021

leocape Feb 16, 2021

vnourdin Feb 16, 2021

nytai commented Feb 15, 2021

nytai commented Feb 16, 2021

leocape commented Feb 16, 2021

leocape commented Feb 16, 2021

Yann-J Feb 14, 2021

leocape Feb 16, 2021

vnourdin Feb 16, 2021

Yann-J commented Feb 16, 2021

dpgaspar left a comment •

edited

Loading

dpgaspar Feb 16, 2021 •

edited

Loading

nytai commented Feb 16, 2021

shemExelate Feb 16, 2021

nytai Feb 16, 2021

srinify commented Feb 26, 2021

Kingflyinger commented Feb 27, 2021 •

edited

Loading

chore: update docs for new alerts and reporting feature #13104

chore: update docs for new alerts and reporting feature #13104

Conversation

leocape commented Feb 13, 2021

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TEST PLAN

ADDITIONAL INFORMATION

Yann-J commented Feb 14, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nytai commented Feb 15, 2021

nytai commented Feb 16, 2021

leocape commented Feb 16, 2021

leocape commented Feb 16, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Yann-J commented Feb 16, 2021

dpgaspar left a comment • edited Loading

Choose a reason for hiding this comment

dpgaspar Feb 16, 2021 • edited Loading

Choose a reason for hiding this comment

nytai commented Feb 16, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

srinify commented Feb 26, 2021

Kingflyinger commented Feb 27, 2021 • edited Loading

dpgaspar left a comment •

edited

Loading

dpgaspar Feb 16, 2021 •

edited

Loading

Kingflyinger commented Feb 27, 2021 •

edited

Loading