prefect.server.events.triggers
The triggers consumer watches events streaming in from the event bus and decides whether to act on them based on the automations that users have set up.
act(firing)
async
Given a Automation that has been triggered, the triggering labels and event
(if there was one), publish an action for the actions
service to process.
Source code in src/prefect/server/events/triggers.py
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
|
consumer(periodic_granularity=timedelta(seconds=5))
async
The triggers.consumer
processes all Events arriving on the event bus to
determine if they meet the automation criteria, queuing up a corresponding
TriggeredAction
for the actions
service if the automation criteria is met.
Source code in src/prefect/server/events/triggers.py
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 |
|
ensure_bucket(db, session, trigger, bucketing_key, start, end, last_event, initial_count=0)
async
Ensures that a bucket has been started for the given automation and key, returning the current bucket. Will not modify the existing bucket.
Source code in src/prefect/server/events/triggers.py
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 |
|
evaluate(session, trigger, bucket, now, triggering_event)
async
Evaluates an Automation, either triggered by a specific event or proactively on a time interval. Evaluating a Automation updates the associated counters for each automation, and will fire the associated action if it has met the threshold.
Source code in src/prefect/server/events/triggers.py
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
|
evaluate_periodically(periodic_granularity)
async
Runs periodic evaluation on the given interval
Source code in src/prefect/server/events/triggers.py
545 546 547 548 549 550 551 552 553 554 555 556 557 |
|
forget_automation(automation_id)
Unloads the given automation from memory
Source code in src/prefect/server/events/triggers.py
602 603 604 605 606 607 |
|
get_events_clock_offset()
async
Calculate the current clock offset. This takes into account both the occurred
of the last event, as well as the time we saw the last event. This helps to
ensure that in low volume environments, we don't end up getting huge offsets.
Source code in src/prefect/server/events/triggers.py
382 383 384 385 386 387 388 389 390 391 392 393 394 395 |
|
get_lost_followers()
async
Get followers that have been sitting around longer than our lookback
Source code in src/prefect/server/events/triggers.py
518 519 520 521 |
|
increment_bucket(db, session, bucket, count, last_event)
async
Adds the given count to the bucket, returning the new bucket
Source code in src/prefect/server/events/triggers.py
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 |
|
load_automation(automation)
Loads the given automation into memory so that it is available for evaluations
Source code in src/prefect/server/events/triggers.py
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 |
|
load_automations(db, session)
async
Loads all automations for the given set of accounts
Source code in src/prefect/server/events/triggers.py
624 625 626 627 628 629 630 631 632 633 634 635 636 637 |
|
periodic_evaluation(now)
async
Periodic tasks that should be run regularly, but not as often as every event
Source code in src/prefect/server/events/triggers.py
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 |
|
proactive_evaluation(trigger, as_of)
async
The core proactive evaluation operation for a single Automation
Source code in src/prefect/server/events/triggers.py
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 |
|
reactive_evaluation(event, depth=0)
async
Evaluate all automations that may apply to this event.
event (ReceivedEvent): The event to evaluate. This object contains all the necessary information about the event, including its type, associated resources, and metadata. depth (int, optional): The current recursion depth. This is used to prevent infinite recursion due to cyclic event dependencies. Defaults to 0 and is incremented with each recursive call.
Source code in src/prefect/server/events/triggers.py
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 |
|
read_bucket(db, session, trigger, bucketing_key)
async
Gets the bucket this event would fall into for the given Automation, if there is one currently
Source code in src/prefect/server/events/triggers.py
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 |
|
read_bucket_by_trigger_id(db, session, automation_id, trigger_id, bucketing_key)
async
Gets the bucket this event would fall into for the given Automation, if there is one currently
Source code in src/prefect/server/events/triggers.py
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 |
|
read_buckets_for_automation(db, session, trigger, batch_size=AUTOMATION_BUCKET_BATCH_SIZE)
async
Yields buckets for the given automation and trigger in batches.
Source code in src/prefect/server/events/triggers.py
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 |
|
remove_bucket(db, session, bucket)
async
Removes the given bucket from the database
Source code in src/prefect/server/events/triggers.py
871 872 873 874 875 876 877 878 879 880 881 882 |
|
remove_buckets_exceeding_threshold(db, session, trigger)
async
Deletes bucket where the count has already exceeded the threshold
Source code in src/prefect/server/events/triggers.py
640 641 642 643 644 645 646 647 648 649 650 651 652 |
|
reset()
async
Resets the in-memory state of the service
Source code in src/prefect/server/events/triggers.py
894 895 896 897 898 899 |
|
start_new_bucket(db, session, trigger, bucketing_key, start, end, count, triggered_at=None)
async
Ensures that a bucket with the given start and end exists with the given count, returning the new bucket
Source code in src/prefect/server/events/triggers.py
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 |
|